Module Picos_std_sync.Stream

Represents a stream of values of type 'a.

create () returns a new stream.

push stream value adds the value to the current position of the stream and advances the stream to the next position unless the stream has been poisoned in which case only the exception given to poison will be raised.

poison_at stream exn bt marks the stream as poisoned at the current position, which means that subsequent attempts to push to the stream will raise the given exception with backtrace.

ℹ️ This operation is not cancelable.

poison stream exn is equivalent to poison_at stream exn (Printexc.get_callstack n) where n defaults to 0.

Represents a (past or current) position in a stream.

tap stream returns a cursor to the current position of the stream.

peek_opt cursor immediately returns Some (value, next) with the value pushed to the position and a cursor to the next position, when the cursor points to a past position in the stream. Otherwise returns None or raises the exception that the stream was poisoned with.

read cursor immediately returns (value, next) with the value pushed to the position and a cursor to the next position, when the cursor points to a past position in the stream. If the cursor points to the current position of the stream, read cursor waits until a value is pushed to the stream or the stream is poisoned, in which case the exception that the stream was poisoned with will be raised.

read_evt cursor returns an event that reads from the cursor position.