jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clarify the behavior of newChan

Browse source 
follow up the advice of `timothee`
This commit is contained in:
flywind 2021-03-12 22:18:10 +08:00 • committed by GitHub
commit 686bf3bfc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/std/channels.nim
View file

@ -506,5 +506,9 @@ func close*[T](c: Channel[T]): bool {.inline.} =
func peek*[T](c: Channel[T]): int {.inline.} = peek(c.d) func peek*[T](c: Channel[T]): int {.inline.} = peek(c.d)
proc newChannel*[T](elements = 30): Channel[T] = proc newChannel*[T](elements = 30): Channel[T] =
## Returns a new `Channel`. `elements` should be positive.
## `elements` is used to specify whether a channel is buffered or not.
## If `elements` = 1, the channel is unbuffered. If `elements` > 1, the
## channel is buffered.
assert elements >= 1, "Elements must be positive!" assert elements >= 1, "Elements must be positive!"
result = Channel[T](d: allocChannel(sizeof(T), elements)) result = Channel[T](d: allocChannel(sizeof(T), elements))