package streamable

  1. Overview
  2. Docs
package streamable
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module State_rpc.Direct_writerSource

Sourcetype ('state_part, 'update_part) t
Sourceval write_state_without_pushback_exn : ('state_part, _) t -> 'state_part -> [ `Ok | `Closed ]

Write a part of the initial state. Returns `Closed if t is closed.

Will raise if the initial state has already been finalised.

Sourceval finalise_state_without_pushback_exn : (_, _) t -> [ `Ok | `Closed ]

Finalise the initial state, indicating there are no more parts. Returns `Closed if t is closed.

Will raise if the initial state has already been finalised.

Sourceval is_state_finalised : (_, _) t -> bool
Sourceval state_finalised : (_, _) t -> unit Async_kernel.Deferred.t
Sourceval write_update_without_pushback_exn : (_, 'update_part) t -> 'update_part -> [ `Ok | `Closed ]

Write a part of an update. Returns `Closed if t is closed.

Will raise if the initial state has not yet been finalised.

Sourceval finalise_update_without_pushback_exn : (_, _) t -> [ `Ok | `Closed ]

Finalise the current update. Returns `Closed if t is closed.

Will raise if the initial state has not yet been finalised.

Sourceval close : (_, _) t -> unit
Sourceval closed : (_, _) t -> unit Async_kernel.Deferred.t
Sourceval flushed : (_, _) t -> unit Async_kernel.Deferred.t
Sourceval is_closed : (_, _) t -> bool
Sourcemodule Expert : sig ... end

Expert allows the serialisation of parts to occur separately from the writing of parts. While you are able to write any bigstring to the pipe rpc with this interface, you should only write state parts until you finalise the state, and then after that you should only write update parts.

Sourcemodule Group : sig ... end
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