package core

You can search for identifiers within the package.

in-package search v0.2.0

Industrial strength alternative to OCaml's standard library

Install

dune-project

Dependency

github.com Readme Changelog MIT License Edit opam file Versions (13)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.14.1.tar.gz

sha256=8c158c12345d36a5cdd71081728f4317b2b04c09eb4126b6de00c482a6fec2a0

md5=b11f58205953d84cedb0003efcdab231

doc/core/Core/Unix/IOVec/index.html

Module `Unix.IOVec`

I/O-vectors for scatter/gather-operations

type 'buf t = private {

buf : 'buf;
(*
Buffer holding the I/O-vector
*)
pos : int;
(*
Position of I/O-vector in buffer
*)
len : int;
(*
Length of I/O-vector in buffer
*)

}

Representation of I/O-vectors. NOTE: DO NOT CHANGE THE MEMORY LAYOUT OF THIS TYPE!!! All C-functions in our bindings that handle I/O-vectors depend on it.

include Ppx_sexp_conv_lib.Sexpable.S1 with type 'buf t := 'buf t

val t_of_sexp : (Sexplib0__.Sexp.t -> 'a) -> Sexplib0__.Sexp.t -> 'a t

val sexp_of_t : ('a -> Sexplib0__.Sexp.t) -> 'a t -> Sexplib0__.Sexp.t

type 'buf kind

Kind of I/O-vector buffers

type bigstring =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

val string_kind : string kind

val bigstring_kind : bigstring kind

val empty : 'buf kind -> 'buf t

empty the empty I/O-vector.

val of_string : ?pos:int -> ?len:int -> string -> string t

of_string ?pos ?len str

returns
an I/O-vector designated by position pos and length len in string str.

raises Invalid_argument
if designated substring out of bounds.

parameter pos
default = 0

parameter len
default = String.length str - pos

val of_bigstring : ?pos:int -> ?len:int -> bigstring -> bigstring t

of_bigstring ?pos ?len bstr

returns
an I/O-vector designated by position pos and length len in bigstring bstr.

raises Invalid_argument
if designated substring out of bounds.

parameter pos
default = 0

parameter len
default = String.length str - pos

val drop : 'buf t -> int -> 'buf t

drop iovec n drops n characters from iovec.

returns
resulting I/O-vector.

raises Failure
if n is greater than length of iovec.

val max_iovecs : int Core_kernel.Lazy.t