diff --git a/hmap/Hmap/Key/index.html b/hmap/Hmap/Key/index.html index 84fab54a..397f1dcd 100644 --- a/hmap/Hmap/Key/index.html +++ b/hmap/Hmap/Key/index.html @@ -1,2 +1,2 @@ -Key (hmap.Hmap.Key)

Module Hmap.Key

Keys.

Keys

val create : unit -> 'a key

create () is a new key.

Existential keys

Exisential keys allows to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

+Key (hmap.Hmap.Key)

Module Hmap.Key

Keys.

Keys

val create : unit -> 'a key

create () is a new key.

Existential keys

Exisential keys allows to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/Make/Key/index.html b/hmap/Hmap/Make/Key/index.html index d6a13e0f..a68d94a1 100644 --- a/hmap/Hmap/Make/Key/index.html +++ b/hmap/Hmap/Make/Key/index.html @@ -1,2 +1,2 @@ -Key (hmap.Hmap.Make.Key)

Module Make.Key

Keys.

Keys

type 'a info = 'a Key_info.t

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

+Key (hmap.Hmap.Make.Key)

Module Make.Key

Keys.

Keys

type 'a info = 'a Key_info.t

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/Make/argument-1-Key_info/index.html b/hmap/Hmap/Make/argument-1-Key_info/index.html index 02b0e5c1..047b294c 100644 --- a/hmap/Hmap/Make/argument-1-Key_info/index.html +++ b/hmap/Hmap/Make/argument-1-Key_info/index.html @@ -1,2 +1,2 @@ -Key_info (hmap.Hmap.Make.Key_info)

Parameter Make.Key_info

type 'a t

The type for key information.

+Key_info (hmap.Hmap.Make.Key_info)

Parameter Make.Key_info

type 'a t

The type for key information.

diff --git a/hmap/Hmap/Make/index.html b/hmap/Hmap/Make/index.html index 865cc862..0c52a2fc 100644 --- a/hmap/Hmap/Make/index.html +++ b/hmap/Hmap/Make/index.html @@ -1,2 +1,2 @@ -Make (hmap.Hmap.Make)

Module Hmap.Make

Functor for heterogeneous maps whose keys hold information of type Key_info.t

Parameters

Signature

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

+Make (hmap.Hmap.Make)

Module Hmap.Make

Functor for heterogeneous maps whose keys hold information of type Key_info.t

Parameters

Signature

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

diff --git a/hmap/Hmap/index.html b/hmap/Hmap/index.html index 79333cd0..021508c0 100644 --- a/hmap/Hmap/index.html +++ b/hmap/Hmap/index.html @@ -1,2 +1,2 @@ -Hmap (hmap.Hmap)

Module Hmap

Heterogeneous value maps.

v0.8.1 - homepage

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

Functorial interface

The functorial interface allows to associate more information to the keys. For example a key name or a key value pretty-printer.

module type KEY_INFO = sig ... end

The type for key information.

module type S = sig ... end

Output signature of the functor Make

module Make (Key_info : KEY_INFO) : S with type 'a Key.info = 'a Key_info.t

Functor for heterogeneous maps whose keys hold information of type Key_info.t

+Hmap (hmap.Hmap)

Module Hmap

Heterogeneous value maps.

v0.8.1 - homepage

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

Functorial interface

The functorial interface allows to associate more information to the keys. For example a key name or a key value pretty-printer.

module type KEY_INFO = sig ... end

The type for key information.

module type S = sig ... end

Output signature of the functor Make

module Make (Key_info : KEY_INFO) : S with type 'a Key.info = 'a Key_info.t

Functor for heterogeneous maps whose keys hold information of type Key_info.t

diff --git a/hmap/Hmap/module-type-KEY_INFO/index.html b/hmap/Hmap/module-type-KEY_INFO/index.html index 716dd1cf..b5aa90df 100644 --- a/hmap/Hmap/module-type-KEY_INFO/index.html +++ b/hmap/Hmap/module-type-KEY_INFO/index.html @@ -1,2 +1,2 @@ -KEY_INFO (hmap.Hmap.KEY_INFO)

Module type Hmap.KEY_INFO

The type for key information.

type 'a t

The type for key information.

+KEY_INFO (hmap.Hmap.KEY_INFO)

Module type Hmap.KEY_INFO

The type for key information.

type 'a t

The type for key information.

diff --git a/hmap/Hmap/module-type-S/Key/index.html b/hmap/Hmap/module-type-S/Key/index.html index 38fbf5cc..fcc7ef1c 100644 --- a/hmap/Hmap/module-type-S/Key/index.html +++ b/hmap/Hmap/module-type-S/Key/index.html @@ -1,2 +1,2 @@ -Key (hmap.Hmap.S.Key)

Module S.Key

Keys.

Keys

type 'a info

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

+Key (hmap.Hmap.S.Key)

Module S.Key

Keys.

Keys

type 'a info

The type for key information.

val create : 'a info -> 'a key

create i is a new key with information i.

val info : 'a key -> 'a info

info k is k's information.

Existential keys

Exisential keys allow to compare keys. This can be useful for functions like filter.

type t

The type for existential keys.

val hide_type : 'a key -> t

hide_type k is an existential key for k.

val equal : t -> t -> bool

equal k k' is true iff k and k' are the same key.

val compare : t -> t -> int

compare k k' is a total order on keys compatible with equal.

diff --git a/hmap/Hmap/module-type-S/index.html b/hmap/Hmap/module-type-S/index.html index 20680ce2..06dd79aa 100644 --- a/hmap/Hmap/module-type-S/index.html +++ b/hmap/Hmap/module-type-S/index.html @@ -1,2 +1,2 @@ -S (hmap.Hmap.S)

Module type Hmap.S

Output signature of the functor Make

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

+S (hmap.Hmap.S)

Module type Hmap.S

Output signature of the functor Make

Keys

type 'a key

The type for keys whose lookup value is of type 'a.

module Key : sig ... end

Keys.

Maps

type t

The type for heterogeneous value maps.

val empty : t

empty is the empty map.

val is_empty : t -> bool

is_empty m is true iff m is empty.

val mem : 'a key -> t -> bool

mem k m is true iff k is bound in m.

val add : 'a key -> 'a -> t -> t

add k v m is m with k bound to v.

val singleton : 'a key -> 'a -> t

singleton k v is add k v empty.

val rem : 'a key -> t -> t

rem k m is m with k unbound.

val find : 'a key -> t -> 'a option

find k m is the value of k's binding in m, if any.

val get : 'a key -> t -> 'a

get k m is the value of k's binding in m.

  • raises Invalid_argument

    if k is not bound in m.

type binding =
  1. | B : 'a key * 'a -> binding

The type for bindings.

val iter : (binding -> unit) -> t -> unit

iter f m applies f to all bindings of m.

val fold : (binding -> 'a -> 'a) -> t -> 'a -> 'a

fold f m acc folds over the bindings of m with f, starting with acc

val for_all : (binding -> bool) -> t -> bool

for_all p m is true iff all bindings of m satisfy p.

val exists : (binding -> bool) -> t -> bool

exists p m is true iff there exists a bindings of m that satisfies p.

val filter : (binding -> bool) -> t -> t

filter p m are the bindings of m that satisfy p.

val cardinal : t -> int

cardinal m is the number of bindings in m.

val any_binding : t -> binding option

any_binding m is a binding of m (if not empty).

val get_any_binding : t -> binding

get_any_binding m is a binding of m.

  • raises Invalid_argument

    if m is empty.

diff --git a/hmap/index.html b/hmap/index.html index bac9f743..c1d808b1 100644 --- a/hmap/index.html +++ b/hmap/index.html @@ -1,2 +1,2 @@ -index (hmap.index)

Package hmap

Package info

changes-files
license-files
readme-files
+index (hmap.index)

Package hmap

Package info

changes-files
license-files
readme-files
diff --git a/iostream/Iostream/In/class-empty/index.html b/iostream/Iostream/In/class-empty/index.html index 03f37e74..2ae4d1a2 100644 --- a/iostream/Iostream/In/class-empty/index.html +++ b/iostream/Iostream/In/class-empty/index.html @@ -1,2 +1,2 @@ -empty (iostream.Iostream.In.empty)

Class In.empty

method input : bytes -> int -> int -> int

Read into the slice. Returns 0 only if the stream is closed.

method close : unit -> unit

Close the input. Must be idempotent.

+empty (iostream.Iostream.In.empty)

Class In.empty

method input : bytes -> int -> int -> int

Read into the slice. Returns 0 only if the stream is closed.

method close : unit -> unit

Close the input. Must be idempotent.

diff --git a/iostream/Iostream/In/class-of_bytes/index.html b/iostream/Iostream/In/class-of_bytes/index.html index 3de27892..1b0480a0 100644 --- a/iostream/Iostream/In/class-of_bytes/index.html +++ b/iostream/Iostream/In/class-of_bytes/index.html @@ -1,2 +1,2 @@ -of_bytes (iostream.Iostream.In.of_bytes)

Class In.of_bytes

inherit t
inherit Iostream__.Seekable.t
+of_bytes (iostream.Iostream.In.of_bytes)

Class In.of_bytes

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/In/class-of_in_channel/index.html b/iostream/Iostream/In/class-of_in_channel/index.html index 9f1ea5ed..53b0b105 100644 --- a/iostream/Iostream/In/class-of_in_channel/index.html +++ b/iostream/Iostream/In/class-of_in_channel/index.html @@ -1,2 +1,2 @@ -of_in_channel (iostream.Iostream.In.of_in_channel)

Class In.of_in_channel

inherit t
inherit Iostream__.Seekable.t
+of_in_channel (iostream.Iostream.In.of_in_channel)

Class In.of_in_channel

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/In/class-of_string/index.html b/iostream/Iostream/In/class-of_string/index.html index 70fe955f..f2a88adc 100644 --- a/iostream/Iostream/In/class-of_string/index.html +++ b/iostream/Iostream/In/class-of_string/index.html @@ -1,2 +1,2 @@ -of_string (iostream.Iostream.In.of_string)

Class In.of_string

inherit t
inherit Iostream__.Seekable.t
+of_string (iostream.Iostream.In.of_string)

Class In.of_string

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/In/class-open_file/index.html b/iostream/Iostream/In/class-open_file/index.html index 7749d369..cb34677a 100644 --- a/iostream/Iostream/In/class-open_file/index.html +++ b/iostream/Iostream/In/class-open_file/index.html @@ -1,2 +1,2 @@ -open_file (iostream.Iostream.In.open_file)

Class In.open_file

inherit t
inherit Iostream__.Seekable.t
+open_file (iostream.Iostream.In.open_file)

Class In.open_file

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/In/class-type-t/index.html b/iostream/Iostream/In/class-type-t/index.html index 25290974..6d454a94 100644 --- a/iostream/Iostream/In/class-type-t/index.html +++ b/iostream/Iostream/In/class-type-t/index.html @@ -1,2 +1,2 @@ -t (iostream.Iostream.In.t)

Class type In.t

An input stream, i.e an incoming stream of bytes.

This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input stream, etc.

method input : bytes -> int -> int -> int

Read into the slice. Returns 0 only if the stream is closed.

method close : unit -> unit

Close the input. Must be idempotent.

+t (iostream.Iostream.In.t)

Class type In.t

An input stream, i.e an incoming stream of bytes.

This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input stream, etc.

method input : bytes -> int -> int -> int

Read into the slice. Returns 0 only if the stream is closed.

method close : unit -> unit

Close the input. Must be idempotent.

diff --git a/iostream/Iostream/In/class-type-t_seekable/index.html b/iostream/Iostream/In/class-type-t_seekable/index.html index 067c0ba1..d732f0e6 100644 --- a/iostream/Iostream/In/class-type-t_seekable/index.html +++ b/iostream/Iostream/In/class-type-t_seekable/index.html @@ -1,2 +1,2 @@ -t_seekable (iostream.Iostream.In.t_seekable)

Class type In.t_seekable

An input stream that is also seekable.

inherit t
inherit Iostream__.Seekable.t
+t_seekable (iostream.Iostream.In.t_seekable)

Class type In.t_seekable

An input stream that is also seekable.

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/In/index.html b/iostream/Iostream/In/index.html index 9184a86a..92315283 100644 --- a/iostream/Iostream/In/index.html +++ b/iostream/Iostream/In/index.html @@ -1,5 +1,5 @@ -In (iostream.Iostream.In)

Module Iostream.In

Input stream.

class type t = object ... end

An input stream, i.e an incoming stream of bytes.

class type t_seekable = object ... end

An input stream that is also seekable.

val create : +In (iostream.Iostream.In)

Module Iostream.In

Input stream.

class type t = object ... end

An input stream, i.e an incoming stream of bytes.

class type t_seekable = object ... end

An input stream that is also seekable.

val create : ?close:(unit -> unit) -> input:(bytes -> int -> int -> int) -> unit -> diff --git a/iostream/Iostream/In_buf/class-bufferized/index.html b/iostream/Iostream/In_buf/class-bufferized/index.html index 2f0d12b6..fb58e998 100644 --- a/iostream/Iostream/In_buf/class-bufferized/index.html +++ b/iostream/Iostream/In_buf/class-bufferized/index.html @@ -1,2 +1,2 @@ -bufferized (iostream.Iostream.In_buf.bufferized)

Class In_buf.bufferized

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+bufferized (iostream.Iostream.In_buf.bufferized)

Class In_buf.bufferized

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/class-of_bytes/index.html b/iostream/Iostream/In_buf/class-of_bytes/index.html index 7c787014..81f3e055 100644 --- a/iostream/Iostream/In_buf/class-of_bytes/index.html +++ b/iostream/Iostream/In_buf/class-of_bytes/index.html @@ -1,2 +1,2 @@ -of_bytes (iostream.Iostream.In_buf.of_bytes)

Class In_buf.of_bytes

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+of_bytes (iostream.Iostream.In_buf.of_bytes)

Class In_buf.of_bytes

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/class-of_in_channel/index.html b/iostream/Iostream/In_buf/class-of_in_channel/index.html index ee7357f0..b9e55c0e 100644 --- a/iostream/Iostream/In_buf/class-of_in_channel/index.html +++ b/iostream/Iostream/In_buf/class-of_in_channel/index.html @@ -1,2 +1,2 @@ -of_in_channel (iostream.Iostream.In_buf.of_in_channel)

Class In_buf.of_in_channel

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+of_in_channel (iostream.Iostream.In_buf.of_in_channel)

Class In_buf.of_in_channel

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/class-of_string/index.html b/iostream/Iostream/In_buf/class-of_string/index.html index 6fb45ee1..237e61e3 100644 --- a/iostream/Iostream/In_buf/class-of_string/index.html +++ b/iostream/Iostream/In_buf/class-of_string/index.html @@ -1,2 +1,2 @@ -of_string (iostream.Iostream.In_buf.of_string)

Class In_buf.of_string

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+of_string (iostream.Iostream.In_buf.of_string)

Class In_buf.of_string

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/class-open_file/index.html b/iostream/Iostream/In_buf/class-open_file/index.html index 138c5ef1..79e3dd01 100644 --- a/iostream/Iostream/In_buf/class-open_file/index.html +++ b/iostream/Iostream/In_buf/class-open_file/index.html @@ -1,2 +1,2 @@ -open_file (iostream.Iostream.In_buf.open_file)

Class In_buf.open_file

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+open_file (iostream.Iostream.In_buf.open_file)

Class In_buf.open_file

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/class-t_from_refill/index.html b/iostream/Iostream/In_buf/class-t_from_refill/index.html index e447c1f6..e477e57e 100644 --- a/iostream/Iostream/In_buf/class-t_from_refill/index.html +++ b/iostream/Iostream/In_buf/class-t_from_refill/index.html @@ -1,2 +1,2 @@ -t_from_refill (iostream.Iostream.In_buf.t_from_refill)

Class In_buf.t_from_refill

A mixin to implement a buffered input by only providing a refill method. Add a close method and it's good to go.

method private virtual refill : Iostream__.Slice.t -> unit

Implementation of the stream: this takes a slice, resets its offset, and fills it with bytes. It must write at least one byte in the slice, unless the underlying input has reached its end.

method input : bytes -> int -> int -> int
method fill_buf : unit -> Iostream__.Slice.t
method consume : int -> unit
+t_from_refill (iostream.Iostream.In_buf.t_from_refill)

Class In_buf.t_from_refill

A mixin to implement a buffered input by only providing a refill method. Add a close method and it's good to go.

method private virtual refill : Iostream__.Slice.t -> unit

Implementation of the stream: this takes a slice, resets its offset, and fills it with bytes. It must write at least one byte in the slice, unless the underlying input has reached its end.

method input : bytes -> int -> int -> int
method fill_buf : unit -> Iostream__.Slice.t
method consume : int -> unit
diff --git a/iostream/Iostream/In_buf/class-type-t/index.html b/iostream/Iostream/In_buf/class-type-t/index.html index 2de1cc03..08477810 100644 --- a/iostream/Iostream/In_buf/class-type-t/index.html +++ b/iostream/Iostream/In_buf/class-type-t/index.html @@ -1,2 +1,2 @@ -t (iostream.Iostream.In_buf.t)

Class type In_buf.t

The implementation of buffered input streams.

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

+t (iostream.Iostream.In_buf.t)

Class type In_buf.t

The implementation of buffered input streams.

inherit Iostream__.In.t
method fill_buf : unit -> Iostream__.Slice.t

ic#fill_buf() returns a slice into the ic's internal buffer, and ensures it's empty only if ic.ic is empty. In other words, the invariant is that this only returns an empty slice if the input stream is exhausted.

method consume : int -> unit

Consume n bytes from the inner buffer. This is only valid if the last call to fill_buf returned a slice with at least n bytes.

diff --git a/iostream/Iostream/In_buf/index.html b/iostream/Iostream/In_buf/index.html index 3a7b3c31..84938a82 100644 --- a/iostream/Iostream/In_buf/index.html +++ b/iostream/Iostream/In_buf/index.html @@ -1,5 +1,5 @@ -In_buf (iostream.Iostream.In_buf)

Module Iostream.In_buf

Buffered input stream.

class type t = object ... end

The implementation of buffered input streams.

class virtual t_from_refill : ?bytes:bytes -> unit -> object ... end

A mixin to implement a buffered input by only providing a refill method. Add a close method and it's good to go.

val create : +In_buf (iostream.Iostream.In_buf)

Module Iostream.In_buf

Buffered input stream.

class type t = object ... end

The implementation of buffered input streams.

class virtual t_from_refill : ?bytes:bytes -> unit -> object ... end

A mixin to implement a buffered input by only providing a refill method. Add a close method and it's good to go.

val create : ?bytes:bytes -> ?close:(unit -> unit) -> refill:(bytes -> int) -> diff --git a/iostream/Iostream/Out/class-dummy/index.html b/iostream/Iostream/Out/class-dummy/index.html index eec540b3..25c66191 100644 --- a/iostream/Iostream/Out/class-dummy/index.html +++ b/iostream/Iostream/Out/class-dummy/index.html @@ -1,2 +1,2 @@ -dummy (iostream.Iostream.Out.dummy)

Class Out.dummy

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

+dummy (iostream.Iostream.Out.dummy)

Class Out.dummy

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

diff --git a/iostream/Iostream/Out/class-map_char/index.html b/iostream/Iostream/Out/class-map_char/index.html index 45b14a80..bf706945 100644 --- a/iostream/Iostream/Out/class-map_char/index.html +++ b/iostream/Iostream/Out/class-map_char/index.html @@ -1,2 +1,2 @@ -map_char (iostream.Iostream.Out.map_char)

Class Out.map_char

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

+map_char (iostream.Iostream.Out.map_char)

Class Out.map_char

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

diff --git a/iostream/Iostream/Out/class-of_buffer/index.html b/iostream/Iostream/Out/class-of_buffer/index.html index 2b5f2f39..58000f29 100644 --- a/iostream/Iostream/Out/class-of_buffer/index.html +++ b/iostream/Iostream/Out/class-of_buffer/index.html @@ -1,2 +1,2 @@ -of_buffer (iostream.Iostream.Out.of_buffer)

Class Out.of_buffer

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

+of_buffer (iostream.Iostream.Out.of_buffer)

Class Out.of_buffer

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

diff --git a/iostream/Iostream/Out/class-of_out_channel/index.html b/iostream/Iostream/Out/class-of_out_channel/index.html index 5c12f008..1023ca55 100644 --- a/iostream/Iostream/Out/class-of_out_channel/index.html +++ b/iostream/Iostream/Out/class-of_out_channel/index.html @@ -1,2 +1,2 @@ -of_out_channel (iostream.Iostream.Out.of_out_channel)

Class Out.of_out_channel

inherit t
inherit Iostream__.Seekable.t
+of_out_channel (iostream.Iostream.Out.of_out_channel)

Class Out.of_out_channel

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/Out/class-type-t/index.html b/iostream/Iostream/Out/class-type-t/index.html index 23dac178..4ca124b0 100644 --- a/iostream/Iostream/Out/class-type-t/index.html +++ b/iostream/Iostream/Out/class-type-t/index.html @@ -1,2 +1,2 @@ -t (iostream.Iostream.Out.t)

Class type Out.t

An output stream, ie. a place into which we can write bytes. This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

+t (iostream.Iostream.Out.t)

Class type Out.t

An output stream, ie. a place into which we can write bytes. This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

method output : bytes -> int -> int -> unit

Output slice

method close : unit -> unit

Close the output. Must be idempotent.

diff --git a/iostream/Iostream/Out/class-type-t_seekable/index.html b/iostream/Iostream/Out/class-type-t_seekable/index.html index 2134d3df..e8d6bca0 100644 --- a/iostream/Iostream/Out/class-type-t_seekable/index.html +++ b/iostream/Iostream/Out/class-type-t_seekable/index.html @@ -1,2 +1,2 @@ -t_seekable (iostream.Iostream.Out.t_seekable)

Class type Out.t_seekable

inherit t
inherit Iostream__.Seekable.t
+t_seekable (iostream.Iostream.Out.t_seekable)

Class type Out.t_seekable

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/Out/index.html b/iostream/Iostream/Out/index.html index abbde864..50579070 100644 --- a/iostream/Iostream/Out/index.html +++ b/iostream/Iostream/Out/index.html @@ -1,5 +1,5 @@ -Out (iostream.Iostream.Out)

Module Iostream.Out

Output stream.

class type t = object ... end

An output stream, ie. a place into which we can write bytes. This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

class type t_seekable = object ... end
class dummy : t
val dummy : t

Dummy output, drops everything written to it.

class of_out_channel : ?close_noerr:bool -> out_channel -> t_seekable
val of_out_channel : ?close_noerr:bool -> out_channel -> t_seekable

Wrap an out channel.

val of_buffer : Stdlib.Buffer.t -> t

of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.

val open_file : +Out (iostream.Iostream.Out)

Module Iostream.Out

Output stream.

class type t = object ... end

An output stream, ie. a place into which we can write bytes. This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

class type t_seekable = object ... end
class dummy : t
val dummy : t

Dummy output, drops everything written to it.

class of_out_channel : ?close_noerr:bool -> out_channel -> t_seekable
val of_out_channel : ?close_noerr:bool -> out_channel -> t_seekable

Wrap an out channel.

val of_buffer : Stdlib.Buffer.t -> t

of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.

val open_file : ?close_noerr:bool -> ?mode:int -> ?flags:open_flag list -> diff --git a/iostream/Iostream/Out_buf/class-bufferized/index.html b/iostream/Iostream/Out_buf/class-bufferized/index.html index 80f87e6d..1d11c0c2 100644 --- a/iostream/Iostream/Out_buf/class-bufferized/index.html +++ b/iostream/Iostream/Out_buf/class-bufferized/index.html @@ -1,2 +1,2 @@ -bufferized (iostream.Iostream.Out_buf.bufferized)

Class Out_buf.bufferized

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

+bufferized (iostream.Iostream.Out_buf.bufferized)

Class Out_buf.bufferized

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

diff --git a/iostream/Iostream/Out_buf/class-dummy/index.html b/iostream/Iostream/Out_buf/class-dummy/index.html index de99e181..f6867547 100644 --- a/iostream/Iostream/Out_buf/class-dummy/index.html +++ b/iostream/Iostream/Out_buf/class-dummy/index.html @@ -1,2 +1,2 @@ -dummy (iostream.Iostream.Out_buf.dummy)

Class Out_buf.dummy

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

+dummy (iostream.Iostream.Out_buf.dummy)

Class Out_buf.dummy

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

diff --git a/iostream/Iostream/Out_buf/class-of_buffer/index.html b/iostream/Iostream/Out_buf/class-of_buffer/index.html index aec1e82d..155a9557 100644 --- a/iostream/Iostream/Out_buf/class-of_buffer/index.html +++ b/iostream/Iostream/Out_buf/class-of_buffer/index.html @@ -1,2 +1,2 @@ -of_buffer (iostream.Iostream.Out_buf.of_buffer)

Class Out_buf.of_buffer

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

+of_buffer (iostream.Iostream.Out_buf.of_buffer)

Class Out_buf.of_buffer

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

diff --git a/iostream/Iostream/Out_buf/class-of_out_channel/index.html b/iostream/Iostream/Out_buf/class-of_out_channel/index.html index bad10367..9c0c31ab 100644 --- a/iostream/Iostream/Out_buf/class-of_out_channel/index.html +++ b/iostream/Iostream/Out_buf/class-of_out_channel/index.html @@ -1,2 +1,2 @@ -of_out_channel (iostream.Iostream.Out_buf.of_out_channel)

Class Out_buf.of_out_channel

inherit t
inherit Iostream__.Seekable.t
+of_out_channel (iostream.Iostream.Out_buf.of_out_channel)

Class Out_buf.of_out_channel

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/Out_buf/class-open_file/index.html b/iostream/Iostream/Out_buf/class-open_file/index.html index 51ee3785..ca935ee3 100644 --- a/iostream/Iostream/Out_buf/class-open_file/index.html +++ b/iostream/Iostream/Out_buf/class-open_file/index.html @@ -1,2 +1,2 @@ -open_file (iostream.Iostream.Out_buf.open_file)

Class Out_buf.open_file

inherit t
inherit Iostream__.Seekable.t
+open_file (iostream.Iostream.Out_buf.open_file)

Class Out_buf.open_file

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/Out_buf/class-t_from_output/index.html b/iostream/Iostream/Out_buf/class-t_from_output/index.html index 3bb586a4..0daef393 100644 --- a/iostream/Iostream/Out_buf/class-t_from_output/index.html +++ b/iostream/Iostream/Out_buf/class-t_from_output/index.html @@ -1,2 +1,2 @@ -t_from_output (iostream.Iostream.Out_buf.t_from_output)

Class Out_buf.t_from_output

Make a bufferized output from a non bufferized output+close.

  • parameter bytes

    the buffer to use. It's owned by this channel as long as the channel exists.

inherit t
method private virtual output_underlying : bytes -> int -> int -> unit

Emit these private bytes, unbufferized

method private virtual close_underlying : unit -> unit

Close the underlying output. The bufferized output will flush and then call this.

+t_from_output (iostream.Iostream.Out_buf.t_from_output)

Class Out_buf.t_from_output

Make a bufferized output from a non bufferized output+close.

  • parameter bytes

    the buffer to use. It's owned by this channel as long as the channel exists.

inherit t
method private virtual output_underlying : bytes -> int -> int -> unit

Emit these private bytes, unbufferized

method private virtual close_underlying : unit -> unit

Close the underlying output. The bufferized output will flush and then call this.

diff --git a/iostream/Iostream/Out_buf/class-type-t/index.html b/iostream/Iostream/Out_buf/class-type-t/index.html index 9a9ab5e4..a89a0b7f 100644 --- a/iostream/Iostream/Out_buf/class-type-t/index.html +++ b/iostream/Iostream/Out_buf/class-type-t/index.html @@ -1,2 +1,2 @@ -t (iostream.Iostream.Out_buf.t)

Class type Out_buf.t

An output stream, ie. a place into which we can write bytes, with a buffer to amortize the cost of operations.

This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

+t (iostream.Iostream.Out_buf.t)

Class type Out_buf.t

An output stream, ie. a place into which we can write bytes, with a buffer to amortize the cost of operations.

This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.

inherit Iostream__.Out.t
method output_char : char -> unit

Output a single char

method flush : unit -> unit

Flush underlying buffer

diff --git a/iostream/Iostream/Out_buf/class-type-t_seekable/index.html b/iostream/Iostream/Out_buf/class-type-t_seekable/index.html index 673dbce5..1f34bafe 100644 --- a/iostream/Iostream/Out_buf/class-type-t_seekable/index.html +++ b/iostream/Iostream/Out_buf/class-type-t_seekable/index.html @@ -1,2 +1,2 @@ -t_seekable (iostream.Iostream.Out_buf.t_seekable)

Class type Out_buf.t_seekable

inherit t
inherit Iostream__.Seekable.t
+t_seekable (iostream.Iostream.Out_buf.t_seekable)

Class type Out_buf.t_seekable

inherit t
inherit Iostream__.Seekable.t
diff --git a/iostream/Iostream/Out_buf/index.html b/iostream/Iostream/Out_buf/index.html index e23eb713..b132ab84 100644 --- a/iostream/Iostream/Out_buf/index.html +++ b/iostream/Iostream/Out_buf/index.html @@ -1,5 +1,5 @@ -Out_buf (iostream.Iostream.Out_buf)

Module Iostream.Out_buf

Buffered output stream.

class type t = object ... end

An output stream, ie. a place into which we can write bytes, with a buffer to amortize the cost of operations.

class type t_seekable = object ... end
val create : +Out_buf (iostream.Iostream.Out_buf)

Module Iostream.Out_buf

Buffered output stream.

class type t = object ... end

An output stream, ie. a place into which we can write bytes, with a buffer to amortize the cost of operations.

class type t_seekable = object ... end
val create : ?flush:(unit -> unit) -> ?close:(unit -> unit) -> output_char:(char -> unit) -> diff --git a/iostream/Iostream/Seekable/class-type-t/index.html b/iostream/Iostream/Seekable/class-type-t/index.html index 5e592599..03dd66c4 100644 --- a/iostream/Iostream/Seekable/class-type-t/index.html +++ b/iostream/Iostream/Seekable/class-type-t/index.html @@ -1,2 +1,2 @@ -t (iostream.Iostream.Seekable.t)

Class type Seekable.t

method seek : int -> unit

Seek in the underlying stream.

  • raises Sys_error

    in case of failure

method pos : unit -> int

Return current offset in underlying stream.

  • raises Sys_error

    in case of failure

+t (iostream.Iostream.Seekable.t)

Class type Seekable.t

method seek : int -> unit

Seek in the underlying stream.

  • raises Sys_error

    in case of failure

method pos : unit -> int

Return current offset in underlying stream.

  • raises Sys_error

    in case of failure

diff --git a/iostream/Iostream/Seekable/index.html b/iostream/Iostream/Seekable/index.html index 199a678e..b44fc312 100644 --- a/iostream/Iostream/Seekable/index.html +++ b/iostream/Iostream/Seekable/index.html @@ -1,2 +1,2 @@ -Seekable (iostream.Iostream.Seekable)

Module Iostream.Seekable

An object we can seek in.

Files can be seeked in, i.e the read/write head can move around.

class type t = object ... end
val seek : t -> int -> unit
val pos : t -> int
+Seekable (iostream.Iostream.Seekable)

Module Iostream.Seekable

An object we can seek in.

Files can be seeked in, i.e the read/write head can move around.

class type t = object ... end
val seek : t -> int -> unit
val pos : t -> int
diff --git a/iostream/Iostream/Slice/index.html b/iostream/Iostream/Slice/index.html index 3f13aeb4..feb3f006 100644 --- a/iostream/Iostream/Slice/index.html +++ b/iostream/Iostream/Slice/index.html @@ -1,2 +1,2 @@ -Slice (iostream.Iostream.Slice)

Module Iostream.Slice

Byte slice or buffer.

type t = {
  1. bytes : bytes;
    (*

    Bytes

    *)
  2. mutable off : int;
    (*

    Offset in bytes

    *)
  3. mutable len : int;
    (*

    Length of the slice. Empty slice has len=0

    *)
}

A slice of bytes. The valid bytes in the slice are bytes[off], bytes[off+1], …, bytes[off+len-1] (i.e len bytes starting at offset off).

val empty : t
val create : int -> t
val of_bytes : bytes -> t
val bytes : t -> bytes
val off : t -> int
val len : t -> int
val consume : t -> int -> unit

Consume the first n bytes from the slice, making it n bytes shorter. This modifies the slice in place.

val find_index_exn : t -> char -> int

find index of c in slice, or raise Not_found

+Slice (iostream.Iostream.Slice)

Module Iostream.Slice

Byte slice or buffer.

type t = Iostream_types.Slice.t = {
  1. bytes : bytes;
    (*

    Bytes

    *)
  2. mutable off : int;
    (*

    Offset in bytes

    *)
  3. mutable len : int;
    (*

    Length of the slice. Empty slice has len=0

    *)
}

A slice of bytes. The valid bytes in the slice are bytes[off], bytes[off+1], …, bytes[off+len-1] (i.e len bytes starting at offset off).

val empty : t
val create : int -> t
val of_bytes : bytes -> t
val bytes : t -> bytes
val off : t -> int
val len : t -> int
val consume : t -> int -> unit

Consume the first n bytes from the slice, making it n bytes shorter. This modifies the slice in place.

val find_index_exn : t -> char -> int

find index of c in slice, or raise Not_found

diff --git a/iostream/Iostream/index.html b/iostream/Iostream/index.html index 9ad2e059..f9c4d7ed 100644 --- a/iostream/Iostream/index.html +++ b/iostream/Iostream/index.html @@ -1,2 +1,2 @@ -Iostream (iostream.Iostream)

Module Iostream

I/O streams.

This module defines generic I/O streams. They can be user-defined and can be composed from other streams.

module In : sig ... end

Input stream.

module In_buf : sig ... end

Buffered input stream.

module Out : sig ... end

Output stream.

module Out_buf : sig ... end

Buffered output stream.

module Slice : sig ... end

Byte slice or buffer.

module Seekable : sig ... end

An object we can seek in.

+Iostream (iostream.Iostream)

Module Iostream

I/O streams.

This module defines generic I/O streams. They can be user-defined and can be composed from other streams.

module In : sig ... end

Input stream.

module In_buf : sig ... end

Buffered input stream.

module Out : sig ... end

Output stream.

module Out_buf : sig ... end

Buffered output stream.

module Slice : sig ... end

Byte slice or buffer.

module Seekable : sig ... end

An object we can seek in.

diff --git a/iostream/Iostream__/index.html b/iostream/Iostream__/index.html index f9de786d..9e15b590 100644 --- a/iostream/Iostream__/index.html +++ b/iostream/Iostream__/index.html @@ -1,2 +1,2 @@ -Iostream__ (iostream.Iostream__)

Module Iostream__

This module is hidden.

+Iostream__ (iostream.Iostream__)

Module Iostream__

This module is hidden.

diff --git a/iostream/Iostream__In/index.html b/iostream/Iostream__In/index.html index be8b500b..f0bee398 100644 --- a/iostream/Iostream__In/index.html +++ b/iostream/Iostream__In/index.html @@ -1,2 +1,2 @@ -Iostream__In (iostream.Iostream__In)

Module Iostream__In

This module is hidden.

+Iostream__In (iostream.Iostream__In)

Module Iostream__In

This module is hidden.

diff --git a/iostream/Iostream__In_buf/index.html b/iostream/Iostream__In_buf/index.html index 941adc30..a9b65a96 100644 --- a/iostream/Iostream__In_buf/index.html +++ b/iostream/Iostream__In_buf/index.html @@ -1,2 +1,2 @@ -Iostream__In_buf (iostream.Iostream__In_buf)

Module Iostream__In_buf

This module is hidden.

+Iostream__In_buf (iostream.Iostream__In_buf)

Module Iostream__In_buf

This module is hidden.

diff --git a/iostream/Iostream__Out/index.html b/iostream/Iostream__Out/index.html index 8af6c27d..ca9e4bbd 100644 --- a/iostream/Iostream__Out/index.html +++ b/iostream/Iostream__Out/index.html @@ -1,2 +1,2 @@ -Iostream__Out (iostream.Iostream__Out)

Module Iostream__Out

This module is hidden.

+Iostream__Out (iostream.Iostream__Out)

Module Iostream__Out

This module is hidden.

diff --git a/iostream/Iostream__Out_buf/index.html b/iostream/Iostream__Out_buf/index.html index 291afeb5..bd0c9e1c 100644 --- a/iostream/Iostream__Out_buf/index.html +++ b/iostream/Iostream__Out_buf/index.html @@ -1,2 +1,2 @@ -Iostream__Out_buf (iostream.Iostream__Out_buf)

Module Iostream__Out_buf

This module is hidden.

+Iostream__Out_buf (iostream.Iostream__Out_buf)

Module Iostream__Out_buf

This module is hidden.

diff --git a/iostream/Iostream__Seekable/index.html b/iostream/Iostream__Seekable/index.html index e4f55301..6130e6c6 100644 --- a/iostream/Iostream__Seekable/index.html +++ b/iostream/Iostream__Seekable/index.html @@ -1,2 +1,2 @@ -Iostream__Seekable (iostream.Iostream__Seekable)

Module Iostream__Seekable

This module is hidden.

+Iostream__Seekable (iostream.Iostream__Seekable)

Module Iostream__Seekable

This module is hidden.

diff --git a/iostream/Iostream__Slice/index.html b/iostream/Iostream__Slice/index.html index 377cf804..1b508e99 100644 --- a/iostream/Iostream__Slice/index.html +++ b/iostream/Iostream__Slice/index.html @@ -1,2 +1,2 @@ -Iostream__Slice (iostream.Iostream__Slice)

Module Iostream__Slice

This module is hidden.

+Iostream__Slice (iostream.Iostream__Slice)

Module Iostream__Slice

This module is hidden.

diff --git a/iostream/Iostream_types/In/class-type-t/index.html b/iostream/Iostream_types/In/class-type-t/index.html new file mode 100644 index 00000000..774e8acf --- /dev/null +++ b/iostream/Iostream_types/In/class-type-t/index.html @@ -0,0 +1,2 @@ + +t (iostream.Iostream_types.In.t)

Class type In.t

method input : bytes -> int -> int -> int

Read into the slice. Returns 0 only if the stream is closed.

method close : unit -> unit

Close the input. Must be idempotent.

diff --git a/iostream/Iostream_types/In/class-type-t_seekable/index.html b/iostream/Iostream_types/In/class-type-t_seekable/index.html new file mode 100644 index 00000000..ebfef3d9 --- /dev/null +++ b/iostream/Iostream_types/In/class-type-t_seekable/index.html @@ -0,0 +1,2 @@ + +t_seekable (iostream.Iostream_types.In.t_seekable)

Class type In.t_seekable

inherit t
inherit Seekable.t
diff --git a/iostream/Iostream_types/In/index.html b/iostream/Iostream_types/In/index.html new file mode 100644 index 00000000..1a08c8be --- /dev/null +++ b/iostream/Iostream_types/In/index.html @@ -0,0 +1,2 @@ + +In (iostream.Iostream_types.In)

Module Iostream_types.In

class type t = object ... end
class type t_seekable = object ... end
diff --git a/iostream/Iostream_types/In_buf/class-type-t/index.html b/iostream/Iostream_types/In_buf/class-type-t/index.html new file mode 100644 index 00000000..54fa8a62 --- /dev/null +++ b/iostream/Iostream_types/In_buf/class-type-t/index.html @@ -0,0 +1,2 @@ + +t (iostream.Iostream_types.In_buf.t)

Class type In_buf.t

inherit In.t
method fill_buf : unit -> Slice.t
method consume : int -> unit
diff --git a/iostream/Iostream_types/In_buf/index.html b/iostream/Iostream_types/In_buf/index.html new file mode 100644 index 00000000..83b84a4e --- /dev/null +++ b/iostream/Iostream_types/In_buf/index.html @@ -0,0 +1,2 @@ + +In_buf (iostream.Iostream_types.In_buf)

Module Iostream_types.In_buf

class type t = object ... end
diff --git a/iostream/Iostream_types/Out/class-type-t/index.html b/iostream/Iostream_types/Out/class-type-t/index.html new file mode 100644 index 00000000..e64819ba --- /dev/null +++ b/iostream/Iostream_types/Out/class-type-t/index.html @@ -0,0 +1,2 @@ + +t (iostream.Iostream_types.Out.t)

Class type Out.t

method output : bytes -> int -> int -> unit
method close : unit -> unit
diff --git a/iostream/Iostream_types/Out/class-type-t_seekable/index.html b/iostream/Iostream_types/Out/class-type-t_seekable/index.html new file mode 100644 index 00000000..39817841 --- /dev/null +++ b/iostream/Iostream_types/Out/class-type-t_seekable/index.html @@ -0,0 +1,2 @@ + +t_seekable (iostream.Iostream_types.Out.t_seekable)

Class type Out.t_seekable

inherit t
inherit Seekable.t
diff --git a/iostream/Iostream_types/Out/index.html b/iostream/Iostream_types/Out/index.html new file mode 100644 index 00000000..ec7781f6 --- /dev/null +++ b/iostream/Iostream_types/Out/index.html @@ -0,0 +1,2 @@ + +Out (iostream.Iostream_types.Out)

Module Iostream_types.Out

class type t = object ... end
class type t_seekable = object ... end
diff --git a/iostream/Iostream_types/Out_buf/class-type-t/index.html b/iostream/Iostream_types/Out_buf/class-type-t/index.html new file mode 100644 index 00000000..5c2c89e6 --- /dev/null +++ b/iostream/Iostream_types/Out_buf/class-type-t/index.html @@ -0,0 +1,2 @@ + +t (iostream.Iostream_types.Out_buf.t)

Class type Out_buf.t

method output_char : char -> unit
method output : bytes -> int -> int -> unit
method flush : unit -> unit
method close : unit -> unit
diff --git a/iostream/Iostream_types/Out_buf/class-type-t_seekable/index.html b/iostream/Iostream_types/Out_buf/class-type-t_seekable/index.html new file mode 100644 index 00000000..b3ff2936 --- /dev/null +++ b/iostream/Iostream_types/Out_buf/class-type-t_seekable/index.html @@ -0,0 +1,2 @@ + +t_seekable (iostream.Iostream_types.Out_buf.t_seekable)

Class type Out_buf.t_seekable

inherit t
inherit Seekable.t
diff --git a/iostream/Iostream_types/Out_buf/index.html b/iostream/Iostream_types/Out_buf/index.html new file mode 100644 index 00000000..f096ac66 --- /dev/null +++ b/iostream/Iostream_types/Out_buf/index.html @@ -0,0 +1,2 @@ + +Out_buf (iostream.Iostream_types.Out_buf)

Module Iostream_types.Out_buf

class type t = object ... end
class type t_seekable = object ... end
diff --git a/iostream/Iostream_types/Seekable/class-type-t/index.html b/iostream/Iostream_types/Seekable/class-type-t/index.html new file mode 100644 index 00000000..3b203884 --- /dev/null +++ b/iostream/Iostream_types/Seekable/class-type-t/index.html @@ -0,0 +1,2 @@ + +t (iostream.Iostream_types.Seekable.t)

Class type Seekable.t

method seek : int -> unit
method pos : unit -> int
diff --git a/iostream/Iostream_types/Seekable/index.html b/iostream/Iostream_types/Seekable/index.html new file mode 100644 index 00000000..85f2e2be --- /dev/null +++ b/iostream/Iostream_types/Seekable/index.html @@ -0,0 +1,2 @@ + +Seekable (iostream.Iostream_types.Seekable)

Module Iostream_types.Seekable

class type t = object ... end
diff --git a/iostream/Iostream_types/Slice/index.html b/iostream/Iostream_types/Slice/index.html new file mode 100644 index 00000000..a64d2a1c --- /dev/null +++ b/iostream/Iostream_types/Slice/index.html @@ -0,0 +1,2 @@ + +Slice (iostream.Iostream_types.Slice)

Module Iostream_types.Slice

type t = {
  1. bytes : bytes;
    (*

    Bytes

    *)
  2. mutable off : int;
    (*

    Offset in bytes

    *)
  3. mutable len : int;
    (*

    Length of the slice. Empty slice has len=0

    *)
}
diff --git a/iostream/Iostream_types/index.html b/iostream/Iostream_types/index.html new file mode 100644 index 00000000..041a8d99 --- /dev/null +++ b/iostream/Iostream_types/index.html @@ -0,0 +1,2 @@ + +Iostream_types (iostream.Iostream_types)

Module Iostream_types

module Slice : sig ... end
module Seekable : sig ... end
module In : sig ... end
module In_buf : sig ... end
module Out : sig ... end
module Out_buf : sig ... end
diff --git a/iostream/Iostream_unix/In/index.html b/iostream/Iostream_unix/In/index.html index 386f652f..4ddee1c2 100644 --- a/iostream/Iostream_unix/In/index.html +++ b/iostream/Iostream_unix/In/index.html @@ -1,2 +1,2 @@ -In (iostream.Iostream_unix.In)

Module Iostream_unix.In

val of_unix_fd : ?close_noerr:bool -> Unix.file_descr -> Iostream.In.t_seekable

Create an in stream from a raw Unix file descriptor. The file descriptor must be opened for reading.

+In (iostream.Iostream_unix.In)

Module Iostream_unix.In

val of_unix_fd : ?close_noerr:bool -> Unix.file_descr -> Iostream.In.t_seekable

Create an in stream from a raw Unix file descriptor. The file descriptor must be opened for reading.

diff --git a/iostream/Iostream_unix/Out/index.html b/iostream/Iostream_unix/Out/index.html index d37ee7c8..1c993a0a 100644 --- a/iostream/Iostream_unix/Out/index.html +++ b/iostream/Iostream_unix/Out/index.html @@ -1,2 +1,2 @@ -Out (iostream.Iostream_unix.Out)

Module Iostream_unix.Out

Output stream directly writing into the given Unix file descriptor.

+Out (iostream.Iostream_unix.Out)

Module Iostream_unix.Out

Output stream directly writing into the given Unix file descriptor.

diff --git a/iostream/Iostream_unix/index.html b/iostream/Iostream_unix/index.html index c4f20ece..07b8506b 100644 --- a/iostream/Iostream_unix/index.html +++ b/iostream/Iostream_unix/index.html @@ -1,2 +1,2 @@ -Iostream_unix (iostream.Iostream_unix)

Module Iostream_unix

module In : sig ... end
module Out : sig ... end
+Iostream_unix (iostream.Iostream_unix)

Module Iostream_unix

module In : sig ... end
module Out : sig ... end
diff --git a/iostream/_doc-dir/CHANGES.md b/iostream/_doc-dir/CHANGES.md index fe81b36a..c8c987ff 100644 --- a/iostream/_doc-dir/CHANGES.md +++ b/iostream/_doc-dir/CHANGES.md @@ -1,4 +1,9 @@ +# 0.3 + +- refactor: extract type definitions to `iostream.types` +- perf slice: improve `Slice.find_index_from` + # 0.2.2 - bugfix for iostream-camlzip (assertion failure) diff --git a/iostream/index.html b/iostream/index.html index 73044d8b..d179289e 100644 --- a/iostream/index.html +++ b/iostream/index.html @@ -1,2 +1,2 @@ -index (iostream.index)

Package iostream

Package info

changes-files
readme-files
+index (iostream.index)

Package iostream

Package info

changes-files
readme-files
diff --git a/ocaml/Afl_instrument/index.html b/ocaml/Afl_instrument/index.html index 33a62806..c38dfd86 100644 --- a/ocaml/Afl_instrument/index.html +++ b/ocaml/Afl_instrument/index.html @@ -1,5 +1,5 @@ -Afl_instrument (ocaml.Afl_instrument)

Module Afl_instrument

Instrumentation for afl-fuzz.

val instrument_function : Cmm.expression -> Debuginfo.t -> Cmm.expression
val instrument_initialiser : +Afl_instrument (ocaml.Afl_instrument)

Module Afl_instrument

Instrumentation for afl-fuzz.

val instrument_function : Cmm.expression -> Debuginfo.t -> Cmm.expression
val instrument_initialiser : Cmm.expression -> (unit -> Debuginfo.t) -> Cmm.expression
diff --git a/ocaml/Alias_analysis/index.html b/ocaml/Alias_analysis/index.html index 1638b9f9..791aff3f 100644 --- a/ocaml/Alias_analysis/index.html +++ b/ocaml/Alias_analysis/index.html @@ -1,5 +1,5 @@ -Alias_analysis (ocaml.Alias_analysis)

Module Alias_analysis

type allocation_point =
  1. | Symbol of Symbol.t
  2. | Variable of Variable.t
type allocated_const =
  1. | Normal of Allocated_const.t
  2. | Array of Lambda.array_kind * Asttypes.mutable_flag * Variable.t list
  3. | Duplicate_array of Lambda.array_kind * Asttypes.mutable_flag * Variable.t
type constant_defining_value =
  1. | Allocated_const of allocated_const
  2. | Block of Tag.t * Variable.t list
  3. | Set_of_closures of Flambda.set_of_closures
  4. | Project_closure of Flambda.project_closure
  5. | Move_within_set_of_closures of Flambda.move_within_set_of_closures
  6. | Project_var of Flambda.project_var
  7. | Field of Variable.t * int
  8. | Symbol_field of Symbol.t * int
  9. | Const of Flambda.const
  10. | Symbol of Symbol.t
  11. | Variable of Variable.t
type initialize_symbol_field = Variable.t option
val run : +Alias_analysis (ocaml.Alias_analysis)

Module Alias_analysis

type allocation_point =
  1. | Symbol of Symbol.t
  2. | Variable of Variable.t
type allocated_const =
  1. | Normal of Allocated_const.t
  2. | Array of Lambda.array_kind * Asttypes.mutable_flag * Variable.t list
  3. | Duplicate_array of Lambda.array_kind * Asttypes.mutable_flag * Variable.t
type constant_defining_value =
  1. | Allocated_const of allocated_const
  2. | Block of Tag.t * Variable.t list
  3. | Set_of_closures of Flambda.set_of_closures
  4. | Project_closure of Flambda.project_closure
  5. | Move_within_set_of_closures of Flambda.move_within_set_of_closures
  6. | Project_var of Flambda.project_var
  7. | Field of Variable.t * int
  8. | Symbol_field of Symbol.t * int
  9. | Const of Flambda.const
  10. | Symbol of Symbol.t
  11. | Variable of Variable.t
type initialize_symbol_field = Variable.t option
val run : constant_defining_value Variable.Tbl.t -> initialize_symbol_field list Symbol.Tbl.t -> Flambda.constant_defining_value Symbol.Tbl.t -> diff --git a/ocaml/Allocated_const/index.html b/ocaml/Allocated_const/index.html index abbf7582..5bdb7881 100644 --- a/ocaml/Allocated_const/index.html +++ b/ocaml/Allocated_const/index.html @@ -1,2 +1,2 @@ -Allocated_const (ocaml.Allocated_const)

Module Allocated_const

Constants that are always allocated (possibly statically). Blocks are not included here since they are always encoded using Prim (Pmakeblock, ...).

type t =
  1. | Float of float
  2. | Int32 of int32
  3. | Int64 of int64
  4. | Nativeint of nativeint
  5. | Float_array of float list
  6. | Immutable_float_array of float list
  7. | String of string
  8. | Immutable_string of string
val compare_floats : float -> float -> int
val compare : t -> t -> int
val print : Stdlib.Format.formatter -> t -> unit
+Allocated_const (ocaml.Allocated_const)

Module Allocated_const

Constants that are always allocated (possibly statically). Blocks are not included here since they are always encoded using Prim (Pmakeblock, ...).

type t =
  1. | Float of float
  2. | Int32 of int32
  3. | Int64 of int64
  4. | Nativeint of nativeint
  5. | Float_array of float list
  6. | Immutable_float_array of float list
  7. | String of string
  8. | Immutable_string of string
val compare_floats : float -> float -> int
val compare : t -> t -> int
val print : Stdlib.Format.formatter -> t -> unit
diff --git a/ocaml/Annot/index.html b/ocaml/Annot/index.html index 27a08279..4defd164 100644 --- a/ocaml/Annot/index.html +++ b/ocaml/Annot/index.html @@ -1,2 +1,2 @@ -Annot (ocaml.Annot)

Module Annot

type call =
  1. | Tail
  2. | Stack
  3. | Inline
type ident =
  1. | Iref_internal of Location.t
  2. | Iref_external
  3. | Idef of Location.t
+Annot (ocaml.Annot)

Module Annot

type call =
  1. | Tail
  2. | Stack
  3. | Inline
type ident =
  1. | Iref_internal of Location.t
  2. | Iref_external
  3. | Idef of Location.t
diff --git a/ocaml/Arch/index.html b/ocaml/Arch/index.html index 0d7dcdf1..4d28a99e 100644 --- a/ocaml/Arch/index.html +++ b/ocaml/Arch/index.html @@ -1,5 +1,5 @@ -Arch (ocaml.Arch)

Module Arch

val command_line_options : (string * Stdlib.Arg.spec * string) list
type addressing_mode =
  1. | Ibased of string * int
  2. | Iindexed of int
  3. | Iindexed2 of int
  4. | Iscaled of int * int
  5. | Iindexed2scaled of int * int
type specific_operation =
  1. | Ilea of addressing_mode
  2. | Istore_int of nativeint * addressing_mode * bool
  3. | Ioffset_loc of int * addressing_mode
  4. | Ifloatarithmem of float_operation * addressing_mode
  5. | Ibswap of int
  6. | Isqrtf
  7. | Ifloatsqrtf of addressing_mode
  8. | Isextend32
  9. | Izextend32
and float_operation =
  1. | Ifloatadd
  2. | Ifloatsub
  3. | Ifloatmul
  4. | Ifloatdiv
val big_endian : bool
val size_addr : int
val size_int : int
val size_float : int
val allow_unaligned_access : bool
val division_crashes_on_overflow : bool
val identity_addressing : addressing_mode
val offset_addressing : addressing_mode -> int -> addressing_mode
val num_args_addressing : addressing_mode -> int
val print_addressing : +Arch (ocaml.Arch)

Module Arch

val command_line_options : (string * Stdlib.Arg.spec * string) list
type addressing_mode =
  1. | Ibased of string * int
  2. | Iindexed of int
  3. | Iindexed2 of int
  4. | Iscaled of int * int
  5. | Iindexed2scaled of int * int
type specific_operation =
  1. | Ilea of addressing_mode
  2. | Istore_int of nativeint * addressing_mode * bool
  3. | Ioffset_loc of int * addressing_mode
  4. | Ifloatarithmem of float_operation * addressing_mode
  5. | Ibswap of int
  6. | Isqrtf
  7. | Ifloatsqrtf of addressing_mode
  8. | Isextend32
  9. | Izextend32
and float_operation =
  1. | Ifloatadd
  2. | Ifloatsub
  3. | Ifloatmul
  4. | Ifloatdiv
val big_endian : bool
val size_addr : int
val size_int : int
val size_float : int
val allow_unaligned_access : bool
val division_crashes_on_overflow : bool
val identity_addressing : addressing_mode
val offset_addressing : addressing_mode -> int -> addressing_mode
val num_args_addressing : addressing_mode -> int
val print_addressing : (Stdlib.Format.formatter -> 'a -> unit) -> addressing_mode -> Stdlib.Format.formatter -> diff --git a/ocaml/Arg_helper/Make/argument-1-S/Key/Map/index.html b/ocaml/Arg_helper/Make/argument-1-S/Key/Map/index.html index f384f64e..55e0eda6 100644 --- a/ocaml/Arg_helper/Make/argument-1-S/Key/Map/index.html +++ b/ocaml/Arg_helper/Make/argument-1-S/Key/Map/index.html @@ -1,5 +1,5 @@ -Map (ocaml.Arg_helper.Make.S.Key.Map)

Module Key.Map

Maps

type key = t

The type of the map keys.

type !+'a t

The type of maps from type key to type 'a.

val empty : 'a t

The empty map.

val add : key -> 'a -> 'a t -> 'a t

add key data m returns a map containing the same bindings as m, plus a binding of key to data. If key was already bound in m to a value that is physically equal to data, m is returned unchanged (the result of the function is then physically equal to m). Otherwise, the previous binding of key in m disappears.

  • before 4.03

    Physical equality was not ensured.

val add_to_list : key -> 'a -> 'a list t -> 'a list t

add_to_list key data m is m with key mapped to l such that l is data :: Map.find key m if key was bound in m and [v] otherwise.

  • since 5.1
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t

update key f m returns a map containing the same bindings as m, except for the binding of key. Depending on the value of y where y is f (find_opt key m), the binding of key is added, removed or updated. If y is None, the binding is removed if it exists; otherwise, if y is Some z then key is associated to z in the resulting map. If key was already bound in m to a value that is physically equal to z, m is returned unchanged (the result of the function is then physically equal to m).

  • since 4.06
val singleton : key -> 'a -> 'a t

singleton x y returns the one-element map that contains a binding y for x.

  • since 3.12
val remove : key -> 'a t -> 'a t

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map. If x was not in m, m is returned unchanged (the result of the function is then physically equal to m).

  • before 4.03

    Physical equality was not ensured.

val merge : +Map (ocaml.Arg_helper.Make.S.Key.Map)

Module Key.Map

Maps

type key = t

The type of the map keys.

type !+'a t

The type of maps from type key to type 'a.

val empty : 'a t

The empty map.

val add : key -> 'a -> 'a t -> 'a t

add key data m returns a map containing the same bindings as m, plus a binding of key to data. If key was already bound in m to a value that is physically equal to data, m is returned unchanged (the result of the function is then physically equal to m). Otherwise, the previous binding of key in m disappears.

  • before 4.03

    Physical equality was not ensured.

val add_to_list : key -> 'a -> 'a list t -> 'a list t

add_to_list key data m is m with key mapped to l such that l is data :: Map.find key m if key was bound in m and [v] otherwise.

  • since 5.1
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t

update key f m returns a map containing the same bindings as m, except for the binding of key. Depending on the value of y where y is f (find_opt key m), the binding of key is added, removed or updated. If y is None, the binding is removed if it exists; otherwise, if y is Some z then key is associated to z in the resulting map. If key was already bound in m to a value that is physically equal to z, m is returned unchanged (the result of the function is then physically equal to m).

  • since 4.06
val singleton : key -> 'a -> 'a t

singleton x y returns the one-element map that contains a binding y for x.

  • since 3.12
val remove : key -> 'a t -> 'a t

remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map. If x was not in m, m is returned unchanged (the result of the function is then physically equal to m).

  • before 4.03

    Physical equality was not ensured.

val merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> diff --git a/ocaml/Arg_helper/Make/argument-1-S/Key/index.html b/ocaml/Arg_helper/Make/argument-1-S/Key/index.html index 498445b7..0ba4f684 100644 --- a/ocaml/Arg_helper/Make/argument-1-S/Key/index.html +++ b/ocaml/Arg_helper/Make/argument-1-S/Key/index.html @@ -1,2 +1,2 @@ -Key (ocaml.Arg_helper.Make.S.Key)

Module S.Key

type t
val of_string : string -> t

The textual representation of a key must not contain '=' or ','.

module Map : Map.S with type key = t
+Key (ocaml.Arg_helper.Make.S.Key)

Module S.Key

type t
val of_string : string -> t

The textual representation of a key must not contain '=' or ','.

module Map : Map.S with type key = t
diff --git a/ocaml/Arg_helper/Make/argument-1-S/Value/index.html b/ocaml/Arg_helper/Make/argument-1-S/Value/index.html index 0fb1cfc0..093ad8da 100644 --- a/ocaml/Arg_helper/Make/argument-1-S/Value/index.html +++ b/ocaml/Arg_helper/Make/argument-1-S/Value/index.html @@ -1,2 +1,2 @@ -Value (ocaml.Arg_helper.Make.S.Value)

Module S.Value

type t
val of_string : string -> t

The textual representation of a value must not contain ','.

+Value (ocaml.Arg_helper.Make.S.Value)

Module S.Value

type t
val of_string : string -> t

The textual representation of a value must not contain ','.

diff --git a/ocaml/Arg_helper/Make/argument-1-S/index.html b/ocaml/Arg_helper/Make/argument-1-S/index.html index 60a31d3c..b4bc42f0 100644 --- a/ocaml/Arg_helper/Make/argument-1-S/index.html +++ b/ocaml/Arg_helper/Make/argument-1-S/index.html @@ -1,2 +1,2 @@ -S (ocaml.Arg_helper.Make.S)

Parameter Make.S

module Key : sig ... end
module Value : sig ... end
+S (ocaml.Arg_helper.Make.S)

Parameter Make.S

module Key : sig ... end
module Value : sig ... end
diff --git a/ocaml/Arg_helper/Make/index.html b/ocaml/Arg_helper/Make/index.html index 1d1fbdff..77d27f65 100644 --- a/ocaml/Arg_helper/Make/index.html +++ b/ocaml/Arg_helper/Make/index.html @@ -1,2 +1,2 @@ -Make (ocaml.Arg_helper.Make)

Module Arg_helper.Make

Parameters

module S : sig ... end

Signature

type parsed
val default : S.Value.t -> parsed
val set_base_default : S.Value.t -> parsed -> parsed
val add_base_override : S.Key.t -> S.Value.t -> parsed -> parsed
val reset_base_overrides : parsed -> parsed
val set_user_default : S.Value.t -> parsed -> parsed
val add_user_override : S.Key.t -> S.Value.t -> parsed -> parsed
val parse : string -> string -> parsed ref -> unit
type parse_result =
  1. | Ok
  2. | Parse_failed of exn
val parse_no_error : string -> parsed ref -> parse_result
val get : key:S.Key.t -> parsed -> S.Value.t
+Make (ocaml.Arg_helper.Make)

Module Arg_helper.Make

Parameters

module S : sig ... end

Signature

type parsed
val default : S.Value.t -> parsed
val set_base_default : S.Value.t -> parsed -> parsed
val add_base_override : S.Key.t -> S.Value.t -> parsed -> parsed
val reset_base_overrides : parsed -> parsed
val set_user_default : S.Value.t -> parsed -> parsed
val add_user_override : S.Key.t -> S.Value.t -> parsed -> parsed
val parse : string -> string -> parsed ref -> unit
type parse_result =
  1. | Ok
  2. | Parse_failed of exn
val parse_no_error : string -> parsed ref -> parse_result
val get : key:S.Key.t -> parsed -> S.Value.t
diff --git a/ocaml/Arg_helper/index.html b/ocaml/Arg_helper/index.html index a5f6777f..3c54ec22 100644 --- a/ocaml/Arg_helper/index.html +++ b/ocaml/Arg_helper/index.html @@ -1,2 +1,2 @@ -Arg_helper (ocaml.Arg_helper)

Module Arg_helper

Decipher command line arguments of the form <value> | <key>=<value>,...

(as used for example for the specification of inlining parameters varying by simplification round).

Warning: this module is unstable and part of compiler-libs.

module Make (S : sig ... end) : sig ... end
+Arg_helper (ocaml.Arg_helper)

Module Arg_helper

Decipher command line arguments of the form <value> | <key>=<value>,...

(as used for example for the specification of inlining parameters varying by simplification round).

Warning: this module is unstable and part of compiler-libs.

module Make (S : sig ... end) : sig ... end
diff --git a/ocaml/Asmgen/index.html b/ocaml/Asmgen/index.html index 254db6b0..12b16e5f 100644 --- a/ocaml/Asmgen/index.html +++ b/ocaml/Asmgen/index.html @@ -1,5 +1,5 @@ -Asmgen (ocaml.Asmgen)

Module Asmgen

From Lambda to assembly code

type middle_end = +Asmgen (ocaml.Asmgen)

Module Asmgen

From Lambda to assembly code

type middle_end = backend:(module Backend_intf.S) -> prefixname:string -> ppf_dump:Stdlib.Format.formatter -> diff --git a/ocaml/Asmlibrarian/index.html b/ocaml/Asmlibrarian/index.html index caa44d6e..f084c553 100644 --- a/ocaml/Asmlibrarian/index.html +++ b/ocaml/Asmlibrarian/index.html @@ -1,2 +1,2 @@ -Asmlibrarian (ocaml.Asmlibrarian)

Module Asmlibrarian

val create_archive : string list -> string -> unit
type error =
  1. | File_not_found of string
  2. | Archiver_error of string
exception Error of error
val report_error : Stdlib.Format.formatter -> error -> unit
+Asmlibrarian (ocaml.Asmlibrarian)

Module Asmlibrarian

val create_archive : string list -> string -> unit
type error =
  1. | File_not_found of string
  2. | Archiver_error of string
exception Error of error
val report_error : Stdlib.Format.formatter -> error -> unit
diff --git a/ocaml/Asmlink/index.html b/ocaml/Asmlink/index.html index 015f9a10..9ca97f23 100644 --- a/ocaml/Asmlink/index.html +++ b/ocaml/Asmlink/index.html @@ -1,5 +1,5 @@ -Asmlink (ocaml.Asmlink)

Module Asmlink