package capnp

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

Module Capnp.ArraySource

The Array module provides a polymorphic container which is similar in spirit to the standard OCaml array, and which has similar performance characteristics, but which uses a Cap'n Proto list for the underlying storage.

Sourcetype ('cap, 'a, 'arr) t

The array type. The first type parameter represents the read and/or write capability, i.e. ro or rw. The second type parameter is the type of elements stored in the array. The third type parameter describes the underlying storage for the array.

Sourceval length : ('cap, 'a, 'arr) t -> int

Return the length (number of elements) of the given array.

Sourceval get : ('cap, 'a, 'arr) t -> int -> 'a

get a n returns element number n of array a, indexed from 0.

  • raises Invalid_argument

    "index out of bounds" if n is outside the range 0 to length a - 1.

Sourceval set : (rw, 'a, 'arr) t -> int -> 'a -> unit

set a n x places value x in element number n of array a, indexed from 0.

  • raises Invalid_argument

    "index out of bounds" if n is outside the range 0 to length a - 1.

Sourceval init : (rw, 'a, 'arr) t -> int -> unit

init a n destroys the content of array a, replacing it with newly-allocated array storage of length n. The new array elements are initialized to the empty state (zero for primitives and default values for structs).

Sourceval mem : ?equal:('a -> 'a -> bool) -> ('cap, 'a, 'arr) t -> 'a -> bool

mem ~equal a x tests whether element x is present in array a, using the provided equality function. If the equality function is not provided, polymorphic compare is used.

Sourceval is_empty : ('cap, 'a, 'arr) t -> bool

is_empty a returns true if array a has length 0.

Sourceval iter : ('cap, 'a, 'arr) t -> f:('a -> unit) -> unit

iter a ~f applies f to each element of array a, in order.

Sourceval iteri : ('cap, 'a, 'arr) t -> f:(int -> 'a -> unit) -> unit

iteri a ~f behaves as iter, but also passes the index of each element as an argument to f.

Sourceval fold : ('cap, 'a, 'arr) t -> init:'acc -> f:('acc -> 'a -> 'acc) -> 'acc

fold a ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of a.

Sourceval fold_right : ('cap, 'a, 'arr) t -> f:('a -> 'acc -> 'acc) -> init:'acc -> 'acc

fold_right a ~f ~init returns f e1 (f e2 (... (f en init) ...)).

Sourceval foldi : ('cap, 'a, 'arr) t -> init:'acc -> f:(int -> 'acc -> 'a -> 'acc) -> 'acc

foldi a ~init f behaves as fold, but also passes the index of each element as an argument to f.

Sourceval foldi_right : ('cap, 'a, 'arr) t -> f:(int -> 'a -> 'acc -> 'acc) -> init:'acc -> 'acc

foldi_right a ~f ~init behaves as foldi, but also passes the index of each element as an argument to f.

Sourceval exists : ('cap, 'a, 'arr) t -> f:('a -> bool) -> bool

exists a ~f returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

Sourceval forall : ('cap, 'a, 'arr) t -> f:('a -> bool) -> bool

forall a ~f returns true if and only if the provided function evalues to true for all elements. This is a short-circuiting operation.

Sourceval count : ('cap, 'a, 'arr) t -> f:('a -> bool) -> int

count a ~f returns the number of elements for which the provided function evaluates to true.

Sourceval find : ('cap, 'a, 'arr) t -> f:('a -> bool) -> 'a option

find a ~f returns as an option the first element for which f evaluates to true.

Sourceval find_map : ('cap, 'a, 'arr) t -> f:('a -> 'b option) -> 'b option

find_map a ~f returns the first evaluation of f that returns Some, and returns None if there is no such element.

Sourceval to_list : ('cap, 'a, 'arr) t -> 'a list

to_list a returns an OCaml list containing all the elements of a, in order.

Sourceval to_array : ('cap, 'a, 'arr) t -> 'a array

to_array a returns an OCaml array containing all the elements of a, in order.

Sourceval set_list : (rw, 'a, 'arr) t -> 'a list -> unit

set_list a lst resizes array a and sets its content of list lst.

Sourceval set_array : (rw, 'a, 'arr) t -> 'a array -> unit

set_array a arr resizes array a and sets its content of OCaml array arr

Sourceval map_array : ('cap, 'a, 'arr) t -> f:('a -> 'b) -> 'b array

map_array a ~f returns | f e1; f e2; ... f en |, where e1..en are the elements of a.

Sourceval map_list : ('cap, 'a, 'arr) t -> f:('a -> 'b) -> 'b list

map_list a ~f returns f e1; f e2; ... f en, where e1..en are the elements of a. The elements are evaluated in reverse order.

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