package caqti

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

Install

Dune Dependency

Authors

Maintainers

Sources

caqti-v2.0.1.tbz
sha256=7eb57225c521fe25395653d960b1c381bb2b2ccae47bc2a827bb16611988da8b
sha512=eeafaf495b08fb8620ddee1711b8f9fa2ca0c79fb450a905c8d071806b7046d665e1e2ac0e7d3c7ca1258455decbf184e689e9ecb2453ec9d952b864f9dd14f4

doc/caqti.platform/Caqti_platform/Connector/Make/argument-1-System/Stream/index.html

Module System.Stream

type ('a, 'err) t = unit -> ('a, 'err) node Fiber.t

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

and ('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.

    *)
val fold : f:('a -> 'state -> 'state) -> ('a, 'err) t -> 'state -> ('state, 'err) result Fiber.t

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

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

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.

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

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.

val to_rev_list : ('a, 'err) t -> ('a list, 'err) result Fiber.t

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

val to_list : ('a, 'err) t -> ('a list, 'err) result Fiber.t

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

val 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.

val map_result : f:('a -> ('b, 'err) result) -> ('a, 'err) t -> ('b, 'err) t
OCaml

Innovation. Community. Security.