module Bigstring: Bigstringtypet =(char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
exception IOError of int * exn
The occurred exception (e.g. Unix_error, End_of_file)
val create : int -> tcreate lengthlength.val of_string : ?pos:int -> ?len:int -> string -> tof_string ?pos ?len strlen in str starting at position pos.pos : default = 0len : default = String.length str - posval to_string : ?pos:int -> ?len:int -> t -> stringto_string ?pos ?len bstrInvalid_argument if the string would exceed runtime limits.len in bstr starting at position pos.pos : default = 0len : default = length bstr - posval check_args : loc:string -> pos:int -> len:int -> t -> unitcheck_args ~loc ~pos ~len bstr checks the position and length
arguments pos and len for bigstrings bstr.Invalid_argument if these arguments are illegal for the given
bigstring using loc to indicate the calling context.val get_opt_len : t -> pos:int -> int option -> intget_opt_len bstr ~pos opt_lenbstr starting at position pos and given optional length
opt_len. This function does not check the validity of its
arguments. Use Bigstring.check_args for that purpose.val length : t -> intlength bstrbstr.val sub_copy : ?pos:int -> ?len:int -> t -> tsub_copy ?pos ?len bstrbstr
that starts at position pos and has length len. The sub-bigstring
is a unique copy of the memory region, i.e. modifying it will not
modify the original bigstring.pos : default = 0len : default = Bigstring.length bstr - posval sub_shared : ?pos:int -> ?len:int -> t -> tsub_shared ?pos ?len bstrbstr
that starts at position pos and has length len. The sub-bigstring
shares the same memory region, i.e. modifying it will modify the
original bigstring. Holding on to the sub-bigstring will also keep
the (usually bigger) original one around.pos : default = 0len : default = Bigstring.length bstr - posval is_mmapped : t -> boolis_mmapped bstrbstr is
memory-mapped.val blit : src:t ->
src_pos:int -> dst:t -> dst_pos:int -> len:int -> unitblit ~src ~src_pos ~dst ~dst_pos ~len blits len characters from
bigstring src starting at position src_pos to bigstring dst
at position dst_pos.Invalid_argument if the designated ranges are out of bounds.val blit_string_bigstring : src:string ->
src_pos:int -> dst:t -> dst_pos:int -> len:int -> unitblit_string_bigstring ~src ~src_pos ~dst ~dst_pos ~len blits len
characters from string src starting at position src_pos to
bigstring dst at position dst_pos.Invalid_argument if the designated ranges are out of bounds.val blit_bigstring_string : src:t ->
src_pos:int -> dst:string -> dst_pos:int -> len:int -> unitblit_bigstring_string ~src ~src_pos ~dst ~dst_pos ~len blits len
characters from bigstring src starting at position src_pos
to string dst at position dst_pos.Invalid_argument if the designated ranges are out of bounds.val read : ?min_len:int -> Unix.file_descr -> ?pos:int -> ?len:int -> t -> intread ?min_len fd ?pos ?len bstr reads at least min_len (must be
greater than or equal zero) and at most len (must be greater than
or equal to min_len) bytes from file descriptor fd, and writes
them to bigstring bstr starting at position pos.Invalid_argument if the designated ranges are out of bounds.IOError in the case of input errors, or on EOF if the
minimum length could not be read.
NOTE: even if len is zero, there may still be errors when reading
from the descriptor!
min_len : default = 0pos : default = 0len : default = length bstr - posval really_read : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unitreally_read fd ?pos ?len bstr reads len bytes from file descriptor
fd, and writes them to bigstring bstr starting at position pos.Invalid_argument if the designated range is out of bounds.IOError in the case of input errors, or on EOF.pos : default = 0len : default = length bstr - posval really_recv : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unitreally_recv sock ?pos ?len bstr receives len bytes from socket
sock, and writes them to bigstring bstr starting at position
pos. If len is zero, the function returns immediately without
performing the underlying system call.Invalid_argument if the designated range is out of bounds.IOError in the case of input errors, or on EOF.pos : default = 0len : default = length bstr - posval read_assume_fd_is_nonblocking : Unix.file_descr -> ?pos:int -> ?len:int -> t -> intread_assume_fd_is_nonblocking fd ?pos ?len bstr reads up to
len bytes into bigstring bstr starting at position pos from
file descriptor fd without yielding to other OCaml-threads.Unix_error in the case of input errors.Invalid_argument if the designated range is out of bounds.pos : default = 0len : default = length bstr - posval input : ?min_len:int ->
Pervasives.in_channel -> ?pos:int -> ?len:int -> t -> intinput ?min_len ic ?pos ?len bstr tries to read len bytes
(guarantees to read at least min_len bytes (must be greater than
or equal to zero and smaller or equal to len), if possible, before
returning) from input channel ic, and writes them to bigstring
bstr starting at position pos.Invalid_argument if the designated range is out of bounds.IOError in the case of input errors, or on premature EOF.
NOTE: even if len is zero, there may still be errors when reading
from the descriptor, which will be done if the internal buffer
is empty!
NOTE: if at least len characters are available in the input channel
buffer and if len is not zero, data will only be fetched from the
channel buffer. Otherwise data will be read until at least min_len
characters are available.
min_len : default = 0pos : default = 0len : default = length bstr - posval really_input : Pervasives.in_channel -> ?pos:int -> ?len:int -> t -> unitreally_input ic ?pos ?len bstr reads exactly len bytes from
input channel ic, and writes them to bigstring bstr starting at
position pos.Invalid_argument if the designated range is out of bounds.IOError in the case of input errors, or on premature EOF.pos : default = 0len : default = length bstr - posval really_write : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unitreally_write fd ?pos ?len bstr writes len bytes in bigstring
bstr starting at position pos to file descriptor fd.Invalid_argument if the designated range is out of bounds.IOError in the case of output errors.pos : default = 0len : default = length bstr - posval really_send_no_sigpipe : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unitreally_send_no_sigpipe sock ?pos ?len bstr sends len bytes in
bigstring bstr starting at position pos to socket sock without
blocking and ignoring SIGPIPE.Invalid_argument if the designated range is out of bounds.IOError in the case of output errors.pos : default = 0len : default = length bstr - posval send_nonblocking_no_sigpipe : Unix.file_descr -> ?pos:int -> ?len:int -> t -> int optionsend_nonblocking_no_sigpipe sock ?pos ?len bstr tries to send
len bytes in bigstring bstr starting at position pos to socket
sock.Invalid_argument if the designated range is out of bounds.Unix_error in the case of output errors.Some bytes_written, or None if the operation
would have blocked.pos : default = 0len : default = length bstr - posval write : Unix.file_descr -> ?pos:int -> ?len:int -> t -> intwrite fd ?pos ?len bstr writes len
bytes in bigstring bstr starting at position pos to file
descriptor fd.Unix_error in the case of output errors.Invalid_argument if the designated range is out of bounds.pos : default = 0len : default = length bstr - posval write_assume_fd_is_nonblocking : Unix.file_descr -> ?pos:int -> ?len:int -> t -> intwrite_assume_fd_is_nonblocking fd ?pos ?len bstr writes len
bytes in bigstring bstr starting at position pos to file
descriptor fd without yielding to other OCaml-threads.Unix_error in the case of output errors.Invalid_argument if the designated range is out of bounds.pos : default = 0len : default = length bstr - posval writev : Unix.file_descr -> ?count:int -> t Unix_ext.IOVec.t array -> intwritev fd ?count iovecs writes count iovecs of
bigstrings to file descriptor fd.Unix_error in the case of output errors.Invalid_argument if count is out of range.count : default = Array.length iovecsval writev_assume_fd_is_nonblocking : Unix.file_descr -> ?count:int -> t Unix_ext.IOVec.t array -> intwritev_assume_fd_is_nonblocking fd ?count iovecs writes count
iovecs of bigstrings to file descriptor fd without yielding to
other OCaml-threads.Unix_error in the case of output errors.Invalid_argument if the designated range is out of bounds.count : default = Array.length iovecsval sendmsg_nonblocking_no_sigpipe : Unix.file_descr ->
?count:int -> t Unix_ext.IOVec.t array -> int optionsendmsg_nonblocking_no_sigpipe sock ?count iovecs sends
count iovecs of bigstrings to socket sock.Unix_error in the case of output errors.Invalid_argument if count is out of range.Some
bytes_written, or None if the operation would have blocked.
This system call will not cause signal SIGPIPE if an attempt is
made to write to a socket that was closed by the other side.count : default = Array.length iovecsval output : ?min_len:int ->
Pervasives.out_channel -> ?pos:int -> ?len:int -> t -> intoutput ?min_len oc ?pos ?len bstr tries to output
len bytes (guarantees to write at least min_len bytes (must be
equal to or greater than zero), if possible, before returning) from
bigstring bstr starting at position pos to output channel oc.Invalid_argument if the designated range is out of bounds.IOError in the case of output errors. The IOError-argument
counting the number of successful bytes includes those that have
been transferred to the channel buffer before the error.
NOTE: you may need to flush oc to make sure that the data is
actually sent.
NOTE: if len characters fit into the channel buffer completely,
they will be buffered. Otherwise writes will be attempted until at
least min_len characters have been sent.
min_len : default = 0pos : default = 0len : default = length bstr - posval really_output : Pervasives.out_channel -> ?pos:int -> ?len:int -> t -> unitreally_output oc ?pos ?len bstr outputs exactly len
bytes from bigstring bstr starting at position pos to output
channel oc.Invalid_argument if the designated range is out of bounds.IOError in the case of output errors. The IOError-argument
counting the number of successful bytes includes those that have
been transferred to the channel buffer before the error.pos : default = 0len : default = length bstr - posval map_file : shared:bool -> Unix.file_descr -> int -> tmap_file shared fd n memory-maps n characters of the data
associated with descriptor fd to a bigstring. Iff shared is
true, all changes to the bigstring will be reflected in the file.val unsafe_blit : src:t ->
src_pos:int -> dst:t -> dst_pos:int -> len:int -> unitunsafe_blit ~src ~src_pos ~dst ~dst_pos ~len similar to
Bigstring.blit, but does not perform any bounds checks. Will crash
on bounds errors!val unsafe_blit_string_bigstring : src:string ->
src_pos:int -> dst:t -> dst_pos:int -> len:int -> unitunsafe_blit_string_bigstring ~src ~src_pos ~dst ~dst_pos ~len
similar to Bigstring.blit_string_bigstring, but does not perform
any bounds checks. Will crash on bounds errors!val unsafe_blit_bigstring_string : src:t ->
src_pos:int -> dst:string -> dst_pos:int -> len:int -> unitunsafe_blit_bigstring_string ~src ~src_pos ~dst ~dst_pos ~len
similar to Bigstring.blit_bigstring_string, but does not perform
any bounds checks. Will crash on bounds errors!val unsafe_read_assume_fd_is_nonblocking : Unix.file_descr -> pos:int -> len:int -> t -> intunsafe_read_assume_fd_is_nonblocking fd ~pos ~len bstr
similar to Bigstring.read_assume_fd_is_nonblocking, but does
not perform any bounds checks. Will crash on bounds errors!val unsafe_write : Unix.file_descr -> pos:int -> len:int -> t -> intunsafe_write fd ~pos ~len bstr similar to
Bigstring.write, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_write_assume_fd_is_nonblocking : Unix.file_descr -> pos:int -> len:int -> t -> intunsafe_write_assume_fd_is_nonblocking fd ~pos ~len bstr
similar to Bigstring.write_assume_fd_is_nonblocking, but does
not perform any bounds checks. Will crash on bounds errors!val unsafe_read : min_len:int -> Unix.file_descr -> pos:int -> len:int -> t -> intunsafe_read ~min_len fd ~pos ~len bstr similar to
Bigstring.read, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_really_recv : Unix.file_descr -> pos:int -> len:int -> t -> unitunsafe_really_recv sock ~pos ~len bstr similar to
Bigstring.really_recv, but does not perform any
bounds checks. Will crash on bounds errors!val unsafe_input : min_len:int ->
Pervasives.in_channel -> pos:int -> len:int -> t -> intunsafe_input ~min_len ic ~pos ~len bstr similar to
Bigstring.input, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_really_write : Unix.file_descr -> pos:int -> len:int -> t -> unitunsafe_really_write fd ~pos ~len bstr similar to
Bigstring.write, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_really_send_no_sigpipe : Unix.file_descr -> pos:int -> len:int -> t -> unitunsafe_really_send_no_sigpipe sock ~pos ~len bstr
similar to Bigstring.send, but does not perform any
bounds checks. Will crash on bounds errors!val unsafe_send_nonblocking_no_sigpipe : Unix.file_descr -> pos:int -> len:int -> t -> int optionunsafe_send_nonblocking_no_sigpipe sock ~pos ~len bstr similar to
Bigstring.send_nonblocking_no_sigpipe, but does not perform any
bounds checks. Will crash on bounds errors!val unsafe_output : min_len:int ->
Pervasives.out_channel -> pos:int -> len:int -> t -> intunsafe_output ~min_len oc ~pos ~len bstr similar to
Bigstring.output, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_writev : Unix.file_descr -> t Unix_ext.IOVec.t array -> int -> intunsafe_writev fd iovecs count similar to
Bigstring.writev, but does not perform any bounds checks.
Will crash on bounds errors!val unsafe_sendmsg_nonblocking_no_sigpipe : Unix.file_descr -> t Unix_ext.IOVec.t array -> int -> int optionunsafe_sendmsg_nonblocking_no_sigpipe fd iovecs count
similar to Bigstring.sendmsg_nonblocking_no_sigpipe, but
does not perform any bounds checks. Will crash on bounds errors!val unsafe_destroy : t -> unitunsafe_destroy bstr destroys the bigstring by deallocating its
associated data or, if memory-mapped, unmapping the corresponding
file, and setting all dimensions to zero. This effectively frees
the associated memory or address-space resources instantaneously.
This feature helps working around a bug in the current OCaml runtime,
which does not correctly estimate how aggressively to reclaim such
resources.
This operation is safe unless you have passed the bigstring to
another thread that is performing operations on it at the same time.
Access to the bigstring after this operation will yield array bounds
exceptions.
Raises Failure if the bigstring has already been deallocated (or
deemed "external", which is treated equivalently), or if it has
proxies, i.e. other bigstrings referring to the same data.