Skip to content

Commit

Permalink
deploy: 7919537
Browse files Browse the repository at this point in the history
  • Loading branch information
Araq committed Feb 10, 2024
1 parent 4e2adad commit 2e673dc
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 52 deletions.
4 changes: 2 additions & 2 deletions atomics.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -497,7 +497,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:18 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:29 UTC</small>
</div>
</div>
</div>
Expand Down
56 changes: 28 additions & 28 deletions channels.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -213,8 +213,8 @@ <h1><a class="toc-backref" href="#7">Types</a></h1>
<dd>

Typed channel
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L261" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L261" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L265" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L265" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -230,8 +230,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<dd>

Shares <tt class="docutils literal"><span class="pre"><span class="Identifier">Channel</span></span></tt> by reference counting.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L281" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L281" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L283" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L283" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -243,8 +243,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<dd>


<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L265" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L265" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L277" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L277" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -258,8 +258,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<p>An initialization procedure, necessary for acquiring resources and initializing internal state of the channel.</p>
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">elements</span></span></tt> is the capacity of the channel and thus how many messages it can hold before it refuses to accept any further messages.</p>

<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L369" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L369" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L371" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L371" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -271,8 +271,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<dd>

Returns an estimation of the current number of messages held by the channel.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L365" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L365" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L367" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L367" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -284,8 +284,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<dd>

Receives a message from the channel. A version of <a class="reference internal nimdoc" title="proc recv (2 overloads)" href="#recv-procs-all">recv</a> that returns the message.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L353" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L353" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L355" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L355" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -297,8 +297,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<p>This blocks the receiving thread until a message was successfully received.</p>
<p>If the channel does not contain any messages this will block the thread until a message get sent to the channel.</p>

<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L344" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L344" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L346" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L346" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -310,8 +310,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<dd>

Receives a message from the channel. A version of <a class="reference internal nimdoc" title="proc recv (2 overloads)" href="#recv-procs-all">recv</a> that returns the message and isolates it.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L358" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L358" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L360" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L360" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -326,8 +326,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<p>The memory of <tt class="docutils literal"><span class="pre"><span class="Identifier">src</span></span></tt> is moved, not copied.</p>
<p>If the channel is already full with messages this will block the thread until messages from the channel are removed.</p>

<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L326" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L326" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L328" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L328" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -344,8 +344,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
Blocking is still possible if another thread uses the blocking version of the <a class="reference internal nimdoc" title="proc send[T](c: Chan[T]; src: sink Isolated[T])" href="#send,Chan[T],sinkIsolated[T]">send proc</a> / <a class="reference internal nimdoc" title="proc recv (2 overloads)" href="#recv-procs-all">recv proc</a> and waits for the data/space to appear in the channel, thus holding the internal lock to channel's buffer.</div>
<p>Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> and does not change <tt class="docutils literal"><span class="pre"><span class="Identifier">dist</span></span></tt> if no message was received.</p>

<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L315" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L315" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -362,8 +362,8 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
Blocking is still possible if another thread uses the blocking version of the <a class="reference internal nimdoc" title="proc send[T](c: Chan[T]; src: sink Isolated[T])" href="#send,Chan[T],sinkIsolated[T]">send proc</a> / <a class="reference internal nimdoc" title="proc recv (2 overloads)" href="#recv-procs-all">recv proc</a> and waits for the data/space to appear in the channel, thus holding the internal lock to channel's buffer.</div>
<p>Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> if the message was not sent because the number of pending messages in the channel exceeded its capacity.</p>

<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L290" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L290" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L292" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L292" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -381,8 +381,8 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
<dd>

Helper template for <tt class="docutils literal"><span class="pre"><span class="Identifier">send</span></span></tt>.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L340" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L340" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L342" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L342" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -394,8 +394,8 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
<dd>

Helper template for <a class="reference external" href="#trySend,Chan[T],sinkIsolated[T]">trySend</a>.
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/tree/master/threading/channels.nim#L311" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/threading/edit/devel/threading/channels.nim#L311" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

</dd>
</div>
Expand All @@ -411,7 +411,7 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:18 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:28 UTC</small>
</div>
</div>
</div>
Expand Down
28 changes: 14 additions & 14 deletions channels.idx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
nimTitle channels channels.html module threading/channels 0
nim Chan channels.html#Chan object Chan 261
nim `=destroy` channels.html#=destroy,Chan[T] proc `=destroy`[T](c: Chan[T]) 265
nim `=copy` channels.html#=copy,Chan[T],Chan[T] proc `=copy`[T](dest: var Chan[T]; src: Chan[T]) 281
nim trySend channels.html#trySend,Chan[T],sinkIsolated[T] proc trySend[T](c: Chan[T]; src: sink Isolated[T]): bool 290
nim trySend channels.html#trySend.t,Chan[T],T template trySend[T](c: Chan[T]; src: T): bool 309
nim tryRecv channels.html#tryRecv,Chan[T],T proc tryRecv[T](c: Chan[T]; dst: var T): bool 313
nim send channels.html#send,Chan[T],sinkIsolated[T] proc send[T](c: Chan[T]; src: sink Isolated[T]) 326
nim send channels.html#send.t,Chan[T],T template send[T](c: Chan[T]; src: T) 340
nim recv channels.html#recv,Chan[T],T proc recv[T](c: Chan[T]; dst: var T) 344
nim recv channels.html#recv,Chan[T] proc recv[T](c: Chan[T]): T 353
nim recvIso channels.html#recvIso,Chan[T] proc recvIso[T](c: Chan[T]): Isolated[T] 358
nim peek channels.html#peek,Chan[T] proc peek[T](c: Chan[T]): int 365
nim newChan channels.html#newChan,Positive proc newChan[T](elements: Positive = 30): Chan[T] 369
nimgrp recv channels.html#recv-procs-all proc 344
nim Chan channels.html#Chan object Chan 265
nim `=destroy` channels.html#=destroy,Chan[T] proc `=destroy`[T](c: Chan[T]) 277
nim `=copy` channels.html#=copy,Chan[T],Chan[T] proc `=copy`[T](dest: var Chan[T]; src: Chan[T]) 283
nim trySend channels.html#trySend,Chan[T],sinkIsolated[T] proc trySend[T](c: Chan[T]; src: sink Isolated[T]): bool 292
nim trySend channels.html#trySend.t,Chan[T],T template trySend[T](c: Chan[T]; src: T): bool 311
nim tryRecv channels.html#tryRecv,Chan[T],T proc tryRecv[T](c: Chan[T]; dst: var T): bool 315
nim send channels.html#send,Chan[T],sinkIsolated[T] proc send[T](c: Chan[T]; src: sink Isolated[T]) 328
nim send channels.html#send.t,Chan[T],T template send[T](c: Chan[T]; src: T) 342
nim recv channels.html#recv,Chan[T],T proc recv[T](c: Chan[T]; dst: var T) 346
nim recv channels.html#recv,Chan[T] proc recv[T](c: Chan[T]): T 355
nim recvIso channels.html#recvIso,Chan[T] proc recvIso[T](c: Chan[T]): Isolated[T] 360
nim peek channels.html#peek,Chan[T] proc peek[T](c: Chan[T]): int 367
nim newChan channels.html#newChan,Positive proc newChan[T](elements: Positive = 30): Chan[T] 371
nimgrp recv channels.html#recv-procs-all proc 346
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -268,7 +268,7 @@ <h1 class="title">Index</h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:19 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:30 UTC</small>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions smartptrs.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -541,7 +541,7 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:18 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:29 UTC</small>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions theindex.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -268,7 +268,7 @@ <h1 class="title">Index</h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:19 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:30 UTC</small>
</div>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions waitgroups.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
Expand Down Expand Up @@ -193,7 +193,7 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-01-13 17:17:19 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-10 04:12:30 UTC</small>
</div>
</div>
</div>
Expand Down

0 comments on commit 2e673dc

Please sign in to comment.