package picos_std

You can search for identifiers within the package.

in-package search v0.2.0

package picos_std

picos_std.awaitable
- Picos_std_awaitable
  - Awaitable
    
    Awaiter
picos_std.event
- Picos_std_event
  - Event
picos_std.finally
- Picos_std_finally
picos_std.structured
- Picos_std_structured
  - Bundle
  - Control
  - Flock
  - Promise
  - Run
picos_std.sync
- Picos_std_sync
  - Condition
  - Ivar
  - Latch
  - Lazy
  - Mutex
  - Semaphore
    
    Binary
    
    Counting
  - Stream

Legend:
Library
Module
Module type
Parameter
Class
Class type

Low level interface for more flexible waiting.

type 'a awaitable := 'a t

An erased type alias for Awaitable.t.

type t

Represents a single use awaiter of a signal to an awaitable.

val add : 'a awaitable -> Picos.Trigger.t -> t

add awaitable trigger creates a single use awaiter, adds it to the FIFO associated with the awaitable, and returns the awaiter.

val remove : t -> unit

remove awaiter marks the awaiter as having been signaled and removes it from the FIFO associated with the awaitable.

ℹ️ If the associated trigger is used with only one awaiter and the Trigger.awaitawait on the trigger returns None, there is no need to explicitly remove the awaiter, because it has already been removed.