package caqti

  1. Overview
  2. Docs
Unified interface to relational database libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (21)

Authors

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>
  2. N
    Nathan Rebours <nathan@cryptosense.com>

Maintainers

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>

Sources

caqti-v1.9.0.tbz
sha256=e1f580848faf3a54f23174067f2c75f77f6a2fe50ca8bc923428d0e1841192c5
sha512=7a11edfcfbbe4855347b066e222cf6bf46d1afedcd4978661b9a2b3931921faa1768a6bc24031fd3afa84537fe2adc8b139399deb77120461bee8fb394d68e82

doc/caqti.blocking/Caqti_blocking/Stream/index.html

Module Caqti_blocking.Stream

Sourcetype ('a, 'err) t = unit -> ('a, 'err) node future

A stream, represented as a lazy chain of Cons-nodes terminating in a Nil or an Error.

Sourceand ('a, 'err) node =
  1. | Nil
    (*

    The node of an empty stream

    *)
  2. | Error of 'err
    (*

    A node of a permanently failed stream.

    *)
  3. | Cons of 'a * ('a, 'err) t
    (*

    A node holding the next element and continuation of a stream.

    *)
Sourceval fold : f:('a -> 'state -> 'state) -> ('a, 'err) t -> 'state -> ('state, 'err) result future

fold ~f stream acc consumes the remainder elements e1, ..., eN of stream and returns Ok (acc |> f e1 |> ... |> f eN) if no error occurred

Sourceval fold_s : f:('a -> 'state -> ('state, 'err) result future) -> ('a, 'clog) t -> 'state -> ('state, [> `Congested of 'clog ] as 'err) result future

fold_s ~f stream acc consumes the remainder of stream, passing each element in order to f along with the latest accumulation starting at acc, and returning the final accumulation if successful. An error result may be due to either the stream provider or the callback, as distinguished with the `Congested constructor.

Sourceval iter_s : f:('a -> (unit, 'err) result future) -> ('a, 'clog) t -> (unit, [> `Congested of 'clog ] as 'err) result future

iter_s ~f stream consumes the remainder of stream, passing each element in order to f. An error result may be due to either the steram provider or the callback, as distinguished with the `Congested constructor.

Sourceval to_rev_list : ('a, 'err) t -> ('a list, 'err) result future

to_rev_list stream consumes the remainder of stream, returning a list of its element in reverse order of production.

Sourceval to_list : ('a, 'err) t -> ('a list, 'err) result future

to_list stream consumes the remainder of stream, returning a list of its element in order of production.

Sourceval of_list : 'a list -> ('a, 'err) t

of_list xs is a non-failing finite stream (re)producing the elements xs in order of occurrence.