1
0
mirror of https://github.com/duke-git/lancet.git synced 2026-02-10 07:42:27 +08:00

doc: add example and update docment for channel

This commit is contained in:
dudaodong
2022-12-31 13:35:44 +08:00
parent cc54dd7ec9
commit a6ba1028c5
5 changed files with 389 additions and 290 deletions

View File

@@ -159,7 +159,7 @@ func main() {
### <span id="Repeat">Repeat</span>
<p>Return a channel, put param `values` into the channel repeatly until cancel the context.</p>
<p>Create channel, put values into the channel repeatly until cancel the context.</p>
<b>Signature:</b>
@@ -197,10 +197,47 @@ func main() {
### <span id="Generate">Generate</span>
<p>Creates a channel, then put values into the channel.</p>
<b>Signature:</b>
```go
func (c *Channel[T]) Generate(ctx context.Context, values ...T) <-chan T
```
<b>Example:</b>
```go
package main
import (
"context"
"fmt"
"github.com/duke-git/lancet/v2/concurrency"
)
func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
c := concurrency.NewChannel[int]()
intStream := c.Generate(ctx, 1, 2, 3)
fmt.Println(<-intStream)
fmt.Println(<-intStream)
fmt.Println(<-intStream)
// Output:
// 1
// 2
// 3
}
```
### <span id="RepeatFn">RepeatFn</span>
<p>Return a channel, excutes fn repeatly, and put the result into retruned channel until cancel context.</p>
<p>Create a channel, excutes fn repeatly, and put the result into the channel, until close context.</p>
<b>Signature:</b>
@@ -329,7 +366,7 @@ func main() {
### <span id="Take">Take</span>
<p>Return a channel whose values are tahken from another channel until cancel context.</p>
<p>Create a channel whose values are taken from another channel with limit number.</p>
<b>Signature:</b>
@@ -376,7 +413,7 @@ func main() {
### <span id="Tee">Tee</span>
<p>Split one channel into two channels until cancel context.</p>
<p>Split one chanel into two channels, until cancel the context.</p>
<b>Signature:</b>

View File

@@ -157,6 +157,44 @@ func main() {
```
### <span id="Generate">Generate</span>
<p>根据传入的值生成channel.</p>
<b>函数签名:</b>
```go
func (c *Channel[T]) Generate(ctx context.Context, values ...T) <-chan T
```
<b>例子:</b>
```go
package main
import (
"context"
"fmt"
"github.com/duke-git/lancet/v2/concurrency"
)
func main() {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
c := concurrency.NewChannel[int]()
intStream := c.Generate(ctx, 1, 2, 3)
fmt.Println(<-intStream)
fmt.Println(<-intStream)
fmt.Println(<-intStream)
// Output:
// 1
// 2
// 3
}
```
### <span id="Repeat">Repeat</span>
<p>返回一个channel将参数`values`重复放入channel直到取消上下文。</p>
@@ -289,7 +327,7 @@ func main() {
### <span id="OrDone">OrDone</span>
<p>将一个channel读入另一个channel直到取消上下文。.</p>
<p>将一个channel读入另一个channel直到取消上下文。</p>
<b>函数签名:</b>