diff --git a/_odoc-theme/manual.css b/_odoc-theme/manual.css index 92a1b438..5e17c4d3 100644 --- a/_odoc-theme/manual.css +++ b/_odoc-theme/manual.css @@ -3,8 +3,8 @@ @import url("theme.css"); /* Copyright (c) 2019 The odig programmers. All rights reserved. - Distributed under the ISC license, see terms at the end of the file. - odig v0.0.9 */ + SPDX-License-Identifier: ISC + odig v0.1.0 */ :root { --font-headings: "PT-Sans-Caption"; --font-body: "PT-Sans"; @@ -373,4 +373,4 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -*/ +*/ \ No newline at end of file diff --git a/_odoc-theme/odoc.css b/_odoc-theme/odoc.css index 1dbc9da2..c6362b73 100644 --- a/_odoc-theme/odoc.css +++ b/_odoc-theme/odoc.css @@ -3,7 +3,7 @@ @import url("theme.css"); /* Copyright (c) 2019 The odig programmers. All rights reserved. - Distributed under the ISC license, see terms at the end of the file. */ + SPDX-License-Identifier: ISC */ /* Reset a few things. */ @@ -62,7 +62,7 @@ table { border-collapse: collapse; border-spacing: 0; } .odoc-nav { grid-area: nav; } .odoc-preamble { grid-area: header; } .odoc-content { grid-area: content; margin: 0 } -.odoc-toc +.odoc-tocs { grid-area: toc; margin-top: var(--size-line); border-top: solid thin var(--color-rule); } @@ -331,4 +331,4 @@ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -*/ +*/ \ No newline at end of file diff --git a/index.html b/index.html index 1556be34..87e7afa3 100644 --- a/index.html +++ b/index.html @@ -1,2 +1,2 @@ -_opam

OCaml package documentation

Browse by name, by tag, the standard library and the OCaml manual (online, latest version).

Generated for /home/runner/work/moonpool/moonpool/_opam/lib

Packages by name

e

  1. either

h

  1. hmap

l

  1. lwt

m

  1. moonpool
  2. moonpool-lwt

o

  1. ocaml

p

  1. picos

t

  1. thread-local-storage

Packages by tag

\ No newline at end of file +_opam

OCaml package documentation

Browse by name, by tag, the standard library and the OCaml manual (online, latest version).

Generated for /home/runner/work/moonpool/moonpool/_opam/lib

Packages by name

e

  1. either

h

  1. hmap

l

  1. lwt

m

  1. moonpool
  2. moonpool-lwt

o

  1. ocaml

p

  1. picos

t

  1. thread-local-storage

Packages by tag

\ No newline at end of file diff --git a/moonpool/Moonpool/Chan/index.html b/moonpool/Moonpool/Chan/index.html index b0930f6d..1242e66e 100644 --- a/moonpool/Moonpool/Chan/index.html +++ b/moonpool/Moonpool/Chan/index.html @@ -1,2 +1,2 @@ -Chan (moonpool.Moonpool.Chan)

Module Moonpool.Chan

Channels.

The channels have bounded size. Push/pop return futures or can use effects to provide an await-friendly version.

The channels became bounded since @0.7 .

type 'a t

Channel carrying values of type 'a.

val create : max_size:int -> unit -> 'a t

Create a channel.

exception Closed
val try_push : 'a t -> 'a -> bool

try_push chan x pushes x into chan. This does not block. Returns true if it succeeded in pushing.

  • raises Closed

    if the channel is closed.

val try_pop : 'a t -> 'a option

try_pop chan pops and return an element if one is available immediately. Otherwise it returns None.

  • raises Closed

    if the channel is closed and empty.

val close : _ t -> unit

Close the channel. Further push and pop calls will fail. This is idempotent.

val push : 'a t -> 'a -> unit

Push the value into the channel, suspending the current task if the channel is currently full.

  • raises Closed

    if the channel is closed

  • since 0.7
val pop : 'a t -> 'a

Pop an element. This might suspend the current task if the channel is currently empty.

  • raises Closed

    if the channel is empty and closed.

  • since 0.7
+Chan (moonpool.Moonpool.Chan)

Module Moonpool.Chan

Channels.

The channels have bounded size. They use effects/await to provide a direct style implementation. Pushing into a full channel, or popping from an empty one, will suspend the current task.

The channels became bounded since @0.7 .

type 'a t

Channel carrying values of type 'a.

val create : max_size:int -> unit -> 'a t

Create a channel.

exception Closed
val try_push : 'a t -> 'a -> bool

try_push chan x pushes x into chan. This does not block. Returns true if it succeeded in pushing.

  • raises Closed

    if the channel is closed.

val try_pop : 'a t -> 'a option

try_pop chan pops and return an element if one is available immediately. Otherwise it returns None.

  • raises Closed

    if the channel is closed and empty.

val close : _ t -> unit

Close the channel. Further push and pop calls will fail. This is idempotent.

val push : 'a t -> 'a -> unit

Push the value into the channel, suspending the current task if the channel is currently full.

  • raises Closed

    if the channel is closed

  • since 0.7
val pop : 'a t -> 'a

Pop an element. This might suspend the current task if the channel is currently empty.

  • raises Closed

    if the channel is empty and closed.

  • since 0.7
diff --git a/ocaml/index.html b/ocaml/index.html index 5f6f7ea8..2624259f 100644 --- a/ocaml/index.html +++ b/ocaml/index.html @@ -1,2 +1,2 @@ -index (ocaml.index)

Package ocaml

Stdlib

Threads

Compiler libs

Package info

changes-files
license-files
readme-files
+index (ocaml.index)

Package ocaml

Library stdlib

Library unix

Library runtime_events

Library str

Library threads

Library ocamldoc

Library compiler-libs

Package info

changes-files
license-files
readme-files