package async_kernel

  1. Overview
  2. Docs
package async_kernel
Legend:
Library
Module
Module type
Parameter
Class
Class type

A pointer to the end of an Async_stream that can be used to extend the stream.

module Deferred : sig ... end
type 'a t
val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.Sexp.t
val create : unit -> _ t

create () returns a new tail.

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

extend t v extends the stream, and will raise an exception if t has been closed.

val close_exn : _ t -> unit

close_exn t closes t. Subsequent calls to close_exn or extend will raise an exception.

val close_if_open : _ t -> unit

close_if_open t closes t, if it's not already closed. If t is already closed, then this is a no-op.

val is_closed : _ t -> bool

is_closed t returns true iff the stream t is closed.

module Stream : sig ... end
val collect : 'a t -> 'a Stream.t

collect t returns the stream starting at the current position of the tail, i.e. the stream consisting of all subsequent extends.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct