package picos_std

You can search for identifiers within the package.

in-package search v0.2.0

Sample libraries for Picos

Install

Dune Dependency

github.com Readme Changelog ISC License Edit opam file Versions (2)

Authors

V

Vesa Karvonen <vesa.a.j.k@gmail.com>

Maintainers

V

Vesa Karvonen <vesa.a.j.k@gmail.com>

Sources

picos-0.5.0.tbz

sha256=862d61383e2df93a876bedcffb1fd1ddc0f96c50b0e9c07943a2aee1f0e182be

sha512=87805379017ef4a7f2c11b954625a3757a0f1431bb9ba59132202de278b3e41adbe0cdc20e3ab23b7c9a8c5a15faeb7ec79348e7d80f2b14274b00df0893b8c0

doc/picos_std.structured/Picos_std_structured/Promise/index.html

Module `Picos_std_structured.Promise`Source

A cancelable promise.

ℹ️ In addition to using a promise to concurrently compute and return a value, a cancelable promise can also represent a concurrent fiber that will continue until it is explicitly canceled.

Sourcetype !'a t

Represents a promise to return value of type 'a.

Sourceval of_value : 'a -> 'a t

of_value value returns a constant completed promise that returns the given value.

ℹ️ Promises can also be created in the scope of a Bundle or a Flock.

Sourceval await : 'a t -> 'a

await promise awaits until the promise has completed and either returns the value that the evaluation of the promise returned, raises the exception that the evaluation of the promise raised, or raises the Terminate exception in case the promise has been canceled.

Sourceval completed : 'a t -> 'a Picos_std_event.Event.t

completed promise returns an event that can be committed to once the promise has completed.

Sourceval is_running : 'a t -> bool

is_running promise determines whether the completion of the promise is still pending.

Sourceval try_terminate : ?callstack:int -> 'a t -> bool

try_terminate promise tries to terminate the promise by canceling it with the Terminate exception and returns true in case of success and false in case the promise had already completed, i.e. either returned, raised, or canceled.

The optional callstack argument specifies the number of callstack entries to capture with the Terminate exception. The default is 0.

Sourceval terminate : ?callstack:int -> 'a t -> unit

terminate promise is equivalent to try_terminate promise |> ignore.

Sourceval terminate_after : ?callstack:int -> 'a t -> seconds:float -> unit

terminate_after ~seconds promise arranges to terminate the promise by canceling it with the Terminate exception after the specified timeout in seconds.