···181 (default [Bigarray.Array1.dim b - off]). *)
182183val to_bigarray: t -> buffer
184-(** [to_bigarray t] converts a {!t} into a {!buffer} Bigarray, using
185 the Bigarray slicing to allocate a fresh array that preserves
186 sharing of the underlying buffer. *)
187···606(** [string ~off ~len str] is the subbuffer of [str] that starts at position [off]
607 (defaults to [0]) and stops at position [off + len] (defaults to
608 [String.length str]). [str] is fully-replaced by an fresh allocated
609- {!Cstruct.buffer}.
610611 @raise Invalid_argument if [off] or [off + len] are not positions of [str].
612*)
···621 [buffer]. *)
622623val start_pos : t -> int
624-(** [start_pos cs] is [cs]'s start position in the base {!Cstruct.buffer}. *)
625626val stop_pos : t -> int
627-(** [stop_pos cs] is [cs]'s stop position in the base {!Cstruct.buffer}. *)
628629val length : t -> int
630(** Returns the length of the current cstruct view. Note that this
···181 (default [Bigarray.Array1.dim b - off]). *)
182183val to_bigarray: t -> buffer
184+(** [to_bigarray t] converts a {!t} into a {!type:buffer} Bigarray, using
185 the Bigarray slicing to allocate a fresh array that preserves
186 sharing of the underlying buffer. *)
187···606(** [string ~off ~len str] is the subbuffer of [str] that starts at position [off]
607 (defaults to [0]) and stops at position [off + len] (defaults to
608 [String.length str]). [str] is fully-replaced by an fresh allocated
609+ {!type:buffer}.
610611 @raise Invalid_argument if [off] or [off + len] are not positions of [str].
612*)
···621 [buffer]. *)
622623val start_pos : t -> int
624+(** [start_pos cs] is [cs]'s start position in the base {!type:buffer}. *)
625626val stop_pos : t -> int
627+(** [stop_pos cs] is [cs]'s stop position in the base {!type:buffer}. *)
628629val length : t -> int
630(** Returns the length of the current cstruct view. Note that this
+4-4
vendor/opam/cstruct/lib/cstruct_cap.mli
···35 The functions that retrieve bytes ({!get_uint8} etc.) require a [read]
36 capability, functions mutating the underlying buffer ({!set_uint8} etc.)
37 require a [write] capability. Allocation of a buffer (via {!create}, ...)
38- returns a [t] with read and write capabilities. {!ro} drops the write
39- capability, {!wo} drops the read capability. The only exception is
40 {!unsafe_to_bigarray} that returns the underlying [Bigarray.t].
4142 Accessors and mutators for fixed size integers (8, 16, 32, 64 bit) are
···516517 {ul
518 {- if [rev] is [false] (default), [l] is at least [min] and at most
519- [max] consecutive [sat] satisfying initial bytes of [cs] or {!empty}
520 if there are no such bytes. [r] are the remaining bytes of [cs].}
521 {- if [rev] is [true], [r] is at least [min] and at most [max]
522- consecutive [sat] satisfying final bytes of [cs] or {!empty}
523 if there are no such bytes. [l] are the remaining bytes of [cs].}}
524525 If [max] is unspecified the span is unlimited. If [min] is unspecified
···35 The functions that retrieve bytes ({!get_uint8} etc.) require a [read]
36 capability, functions mutating the underlying buffer ({!set_uint8} etc.)
37 require a [write] capability. Allocation of a buffer (via {!create}, ...)
38+ returns a [t] with read and write capabilities. {!val:ro} drops the write
39+ capability, {!val:wo} drops the read capability. The only exception is
40 {!unsafe_to_bigarray} that returns the underlying [Bigarray.t].
4142 Accessors and mutators for fixed size integers (8, 16, 32, 64 bit) are
···516517 {ul
518 {- if [rev] is [false] (default), [l] is at least [min] and at most
519+ [max] consecutive [sat] satisfying initial bytes of [cs] or {!is_empty}
520 if there are no such bytes. [r] are the remaining bytes of [cs].}
521 {- if [rev] is [true], [r] is at least [min] and at most [max]
522+ consecutive [sat] satisfying final bytes of [cs] or {!is_empty}
523 if there are no such bytes. [l] are the remaining bytes of [cs].}}
524525 If [max] is unspecified the span is unlimited. If [min] is unspecified
+1-2
vendor/opam/cstruct/lib/cstruct_sexp.mli
···17(** Sexpression serialisers for {!Cstruct.t} values *)
1819type buffer = Cstruct.buffer
20-(** [buffer] is an alias for the corresponding {!Cstruct.buffer} type *)
2122val sexp_of_buffer : Cstruct.buffer -> Sexplib.Sexp.t
23(** [sexp_of_buffer b] returns the s-expression representation of the raw memory buffer [b] *)
···35val t_of_sexp : Sexplib.Sexp.t -> t
36(** [t_of_sexp s] returns a fresh {!Cstruct.t} that represents the
37 s-expression previously serialised by {!sexp_of_t}. *)
38-
···17(** Sexpression serialisers for {!Cstruct.t} values *)
1819type buffer = Cstruct.buffer
20+(** [buffer] is an alias for the corresponding {!type:Cstruct.buffer} type *)
2122val sexp_of_buffer : Cstruct.buffer -> Sexplib.Sexp.t
23(** [sexp_of_buffer b] returns the s-expression representation of the raw memory buffer [b] *)
···35val t_of_sexp : Sexplib.Sexp.t -> t
36(** [t_of_sexp s] returns a fresh {!Cstruct.t} that represents the
37 s-expression previously serialised by {!sexp_of_t}. *)
0