Up

Module Bigstring

String type based on Bigarray, for use in I/O and C-bindings

Signature

type t = (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t
val compare : t -> t -> int
val t_of_sexp : Sexplib.Sexp.t -> t
val sexp_of_t : t -> Sexplib.Sexp.t
val bin_t : t Bin_prot.Type_class.t
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot.Read.reader
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_writer_t : t Bin_prot.Type_class.writer
val create : ?max_mem_waiting_gc:Core_kernel.Byte_units.t -> int -> t
val init : int -> f:(int -> char) -> t
val of_string : ?pos:int -> ?len:int -> string -> t
val to_string : ?pos:int -> ?len:int -> t -> string
val concat : ?sep:t -> t list -> t
val check_args : loc:string -> pos:int -> len:int -> t -> unit
val get_opt_len : t -> pos:int -> int option -> int
val length : t -> int
val sub_shared : ?pos:int -> ?len:int -> t -> t
external get : t -> int -> char = "%caml_ba_ref_1"
external set : t -> int -> char -> unit = "%caml_ba_set_1"
external is_mmapped : t -> bool = "bigstring_is_mmapped_stub" "noalloc"
val unsafe_blit : (t, t) Core_kernel.Blit_intf.blit
module To_string : sig .. end
module From_string : sig .. end
val write_bin_prot : t -> ?pos:int -> 'a Bin_prot.Type_class.writer -> 'a -> int
val read_bin_prot : t -> ?pos:int -> ?len:int -> 'a Bin_prot.Type_class.reader -> ('a * int) Core_kernel.Or_error.t
val read_bin_prot_verbose_errors : t -> ?pos:int -> ?len:int -> 'a Bin_prot.Type_class.reader -> [
| `Invalid_data of Core_kernel.Error.t
| `Not_enough_data
| `Ok of 'a * int
]
val map_file : shared:bool -> Unix.file_descr -> int -> t
val find : ?pos:int -> ?len:int -> char -> t -> int option
external unsafe_find : t -> char -> pos:int -> len:int -> int = "bigstring_find" "noalloc"
external unsafe_destroy : t -> unit = "bigstring_destroy_stub"
val unsafe_get_int8 : t -> pos:int -> int
val unsafe_set_int8 : t -> pos:int -> int -> unit
val unsafe_get_uint8 : t -> pos:int -> int
val unsafe_set_uint8 : t -> pos:int -> int -> unit
val unsafe_get_int16_le : t -> pos:int -> int
val unsafe_get_int16_be : t -> pos:int -> int
val unsafe_set_int16_le : t -> pos:int -> int -> unit
val unsafe_set_int16_be : t -> pos:int -> int -> unit
val unsafe_get_uint16_le : t -> pos:int -> int
val unsafe_get_uint16_be : t -> pos:int -> int
val unsafe_set_uint16_le : t -> pos:int -> int -> unit
val unsafe_set_uint16_be : t -> pos:int -> int -> unit
val unsafe_get_int32_le : t -> pos:int -> int
val unsafe_get_int32_be : t -> pos:int -> int
val unsafe_set_int32_le : t -> pos:int -> int -> unit
val unsafe_set_int32_be : t -> pos:int -> int -> unit
val unsafe_get_uint32_le : t -> pos:int -> int
val unsafe_get_uint32_be : t -> pos:int -> int
val unsafe_set_uint32_le : t -> pos:int -> int -> unit
val unsafe_set_uint32_be : t -> pos:int -> int -> unit
val unsafe_get_int64_le_exn : t -> pos:int -> int
val unsafe_get_int64_be_exn : t -> pos:int -> int
val unsafe_get_int64_le_trunc : t -> pos:int -> int
val unsafe_get_int64_be_trunc : t -> pos:int -> int
val unsafe_set_int64_le : t -> pos:int -> int -> unit
val unsafe_set_int64_be : t -> pos:int -> int -> unit
val unsafe_get_uint64_be_exn : t -> pos:int -> int
val unsafe_get_uint64_le_exn : t -> pos:int -> int
val unsafe_set_uint64_le : t -> pos:int -> int -> unit
val unsafe_set_uint64_be : t -> pos:int -> int -> unit
val unsafe_get_int32_t_le : t -> pos:int -> Int32.t
val unsafe_get_int32_t_be : t -> pos:int -> Int32.t
val unsafe_set_int32_t_le : t -> pos:int -> Int32.t -> unit
val unsafe_set_int32_t_be : t -> pos:int -> Int32.t -> unit
val unsafe_get_int64_t_le : t -> pos:int -> Int64.t
val unsafe_get_int64_t_be : t -> pos:int -> Int64.t
val unsafe_set_int64_t_le : t -> pos:int -> Int64.t -> unit
val unsafe_set_int64_t_be : t -> pos:int -> Int64.t -> unit
val get_tail_padded_fixed_string : padding:char -> t -> pos:int -> len:int -> unit -> string
val set_tail_padded_fixed_string : padding:char -> t -> pos:int -> len:int -> string -> unit
val get_head_padded_fixed_string : padding:char -> t -> pos:int -> len:int -> unit -> string
val set_head_padded_fixed_string : padding:char -> t -> pos:int -> len:int -> string -> unit
exception IOError of int * exn

Type of I/O errors

The occurred exception (e.g. Unix_error, End_of_file)

Input functions
val read : ?min_len:int -> Unix.file_descr -> ?pos:int -> ?len:int -> t -> int

read ?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.

Returns the number of bytes actually read.
read returns zero only if len = 0. If len > 0 and there's nothing left to read, read raises to indicate EOF even if min_len = 0.
NOTE: even if len is zero, there may still be errors when reading from the descriptor!
Raises [Invalid_argument] if the designated ranges are out of bounds.
Raises [IOError] in the case of input errors, or on EOF if the minimum length could not be read.
Param [pos] default = 0
Param [min_len] default = 0
Param [len] default = length bstr - pos
val really_read : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unit

really_read fd ?pos ?len bstr reads len bytes from file descriptor fd, and writes them to bigstring bstr starting at position pos.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of input errors, or on EOF.
Param [pos] default = 0
Param [len] default = length bstr - pos
val really_recv : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unit

really_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.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of input errors, or on EOF.
Param [pos] default = 0
Param [len] default = length bstr - pos
val recvfrom_assume_fd_is_nonblocking : Unix.file_descr -> ?pos:int -> ?len:int -> t -> int * Unix.sockaddr

recvfrom_assume_fd_is_nonblocking sock ?pos ?len bstr reads up to len bytes into bigstring bstr starting at position pos from socket sock without yielding to other OCaml-threads.

Returns the number of bytes actually read and the socket address of the client.
Raises [Unix_error] in the case of input errors.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val read_assume_fd_is_nonblocking : Unix.file_descr -> ?pos:int -> ?len:int -> t -> Syscall_result.Int.t

read_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.

Returns the number of bytes actually read.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val pread_assume_fd_is_nonblocking : Unix.file_descr -> offset:int -> ?pos:int -> ?len:int -> t -> int

pread_assume_fd_is_nonblocking fd ~offset ?pos ?len bstr reads up to len bytes from file descriptor fd at offset offset, and writes them to bigstring bstr starting at position pos. The fd must be capable of seeking, and the current file offset used for a regular read() is unchanged. Please see 'man pread' for more information.

Returns the number of bytes actually read.
Raises [Invalid_argument] if the designated range is out of bounds.
Raises [Unix_error] in the case of input errors.
Param [pos] default = 0
Param [len] default = length bstr - pos
val input : ?min_len:int -> Core_kernel.Std.in_channel -> ?pos:int -> ?len:int -> t -> int

input ?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.

Returns the number of bytes actually read.
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.
Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of input errors, or on premature EOF.
Param [pos] default = 0
Param [min_len] default = 0
Param [len] default = length bstr - pos
val really_input : Core_kernel.Std.in_channel -> ?pos:int -> ?len:int -> t -> unit

really_input ic ?pos ?len bstr reads exactly len bytes from input channel ic, and writes them to bigstring bstr starting at position pos.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of input errors, or on premature EOF.
Param [pos] default = 0
Param [len] default = length bstr - pos
Output functions
val really_write : Unix.file_descr -> ?pos:int -> ?len:int -> t -> unit

really_write fd ?pos ?len bstr writes len bytes in bigstring bstr starting at position pos to file descriptor fd.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of output errors.
Param [pos] default = 0
Param [len] default = length bstr - pos
val really_send_no_sigpipe : (Unix.file_descr -> ?pos:int -> ?len:int -> t -> unit) Core_kernel.Std.Or_error.t

really_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.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [IOError] in the case of output errors.
Param [pos] default = 0
Param [len] default = length bstr - pos
really_send_no_sigpipe is not implemented on some platforms, in which case it is an Error value that indicates that it is unimplemented.
val send_nonblocking_no_sigpipe : (Unix.file_descr -> ?pos:int -> ?len:int -> t -> Syscall_result.Int.t) Core_kernel.Std.Or_error.t

send_nonblocking_no_sigpipe sock ?pos ?len bstr tries to send len bytes in bigstring bstr starting at position pos to socket sock.

Returns bytes_written.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val sendto_nonblocking_no_sigpipe : (Unix.file_descr -> ?pos:int -> ?len:int -> t -> Unix.sockaddr -> Syscall_result.Int.t) Core_kernel.Std.Or_error.t

sendto_nonblocking_no_sigpipe sock ?pos ?len bstr sockaddr tries to send len bytes in bigstring bstr starting at position pos to socket sock using address addr.

Returns bytes_written.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val write : Unix.file_descr -> ?pos:int -> ?len:int -> t -> int

write fd ?pos ?len bstr writes len bytes in bigstring bstr starting at position pos to file descriptor fd.

Returns the number of bytes actually written.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val pwrite_assume_fd_is_nonblocking : Unix.file_descr -> offset:int -> ?pos:int -> ?len:int -> t -> int

pwrite_assume_fd_is_nonblocking fd ~offset ?pos ?len bstr writes up to len bytes of bigstring bstr starting at position pos to file descriptor fd at position offset. The fd must be capable of seeking, and the current file offset used for non-positional read()/write() calls is unchanged.

Returns the number of bytes written.
Raises [Invalid_argument] if the designated range is out of bounds.
Raises [Unix_error] in the case of input errors.
Param [pos] default = 0
Param [len] default = length bstr - pos
val write_assume_fd_is_nonblocking : Unix.file_descr -> ?pos:int -> ?len:int -> t -> int

write_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.

Returns the number of bytes actually written.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [pos] default = 0
Param [len] default = length bstr - pos
val writev : Unix.file_descr -> ?count:int -> t Core_unix.IOVec.t array -> int

writev fd ?count iovecs writes count iovecs of bigstrings to file descriptor fd.

Returns the number of bytes written.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if count is out of range.
Param [count] default = Array.length iovecs
val writev_assume_fd_is_nonblocking : Unix.file_descr -> ?count:int -> t Core_unix.IOVec.t array -> int

writev_assume_fd_is_nonblocking fd ?count iovecs writes count iovecs of bigstrings to file descriptor fd without yielding to other OCaml-threads.

Returns the number of bytes actually written.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [count] default = Array.length iovecs
val recvmmsg_assume_fd_is_nonblocking : (Unix.file_descr -> ?count:int -> ?srcs:Unix.sockaddr array -> t Core_unix.IOVec.t array -> lens:int array -> int) Core_kernel.Std.Or_error.t

recvmmsg_assume_fd_is_nonblocking fd iovecs ~count ~lens receives up to count messages into iovecs from file descriptor fd without yielding to other OCaml threads. If ~count is supplied, it must be that 0 <= count <= Array.length iovecs. If ~srcs is supplied, save the source addresses for corresponding recieved messages there. If supplied, Array.length srcs must be >= count. Save the lengths of the received messages in lens. It is required that Array.length lens >= count.

If an IOVec isn't long enough for its corresponding message, excess bytes may be discarded, depending on the type of socket the message is received from. While the recvmmsg system call itself does return details of such truncation, etc., those details are not (yet) passed through this interface.

See DOC [recvmmsg(2)] re. the underlying system call.
Returns the number of messages actually read, or a negative number to indicate EWOULDBLOCK or EAGAIN. This is a compromise to mitigate the exception overhead for what ends up being a very common result with our use of recvmmsg.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if the designated range is out of bounds.
Param [count] default = Array.length iovecs
val sendmsg_nonblocking_no_sigpipe : (Unix.file_descr -> ?count:int -> t Core_unix.IOVec.t array -> int option) Core_kernel.Std.Or_error.t

sendmsg_nonblocking_no_sigpipe sock ?count iovecs sends count iovecs of bigstrings to socket sock.

Returns 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.
Raises [Unix_error] in the case of output errors.
Raises [Invalid_argument] if count is out of range.
Param [count] default = Array.length iovecs
val output : ?min_len:int -> Core_kernel.Std.out_channel -> ?pos:int -> ?len:int -> t -> int

output ?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.

Returns the number of bytes actually written.
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.
Raises [Invalid_argument] if the designated range is out of bounds.
Raises [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.
Param [pos] default = 0
Param [min_len] default = 0
Param [len] default = length bstr - pos
val really_output : Core_kernel.Std.out_channel -> ?pos:int -> ?len:int -> t -> unit

really_output oc ?pos ?len bstr outputs exactly len bytes from bigstring bstr starting at position pos to output channel oc.

Raises [Invalid_argument] if the designated range is out of bounds.
Raises [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.
Param [pos] default = 0
Param [len] default = length bstr - pos
Unsafe functions
external unsafe_read_assume_fd_is_nonblocking : Unix.file_descr -> pos:int -> len:int -> t -> Syscall_result.Int.t = "bigstring_read_assume_fd_is_nonblocking_stub"

unsafe_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!

external unsafe_write : Unix.file_descr -> pos:int -> len:int -> t -> int = "bigstring_write_stub"

unsafe_write fd ~pos ~len bstr similar to Bigstring.write, but does not perform any bounds checks. Will crash on bounds errors!

external unsafe_write_assume_fd_is_nonblocking : Unix.file_descr -> pos:int -> len:int -> t -> int = "bigstring_write_assume_fd_is_nonblocking_stub"

unsafe_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!

external unsafe_read : min_len:int -> Unix.file_descr -> pos:int -> len:int -> t -> int = "bigstring_read_stub"

unsafe_read ~min_len fd ~pos ~len bstr similar to Bigstring.read, but does not perform any bounds checks. Will crash on bounds errors!

external unsafe_really_recv : Unix.file_descr -> pos:int -> len:int -> t -> unit = "bigstring_really_recv_stub"

unsafe_really_recv sock ~pos ~len bstr similar to Bigstring.really_recv, but does not perform any bounds checks. Will crash on bounds errors!

external unsafe_really_write : Unix.file_descr -> pos:int -> len:int -> t -> unit = "bigstring_really_write_stub"

unsafe_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 -> unit) Core_kernel.Std.Or_error.t

unsafe_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 -> Syscall_result.Int.t) Core_kernel.Std.Or_error.t

unsafe_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!

external unsafe_writev : Unix.file_descr -> t Core_unix.IOVec.t array -> int -> int = "bigstring_writev_stub"

unsafe_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 Core_unix.IOVec.t array -> int -> int option) Core_kernel.Std.Or_error.t

unsafe_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!

external unsafe_input : min_len:int -> Core_kernel.Std.in_channel -> pos:int -> len:int -> t -> int = "bigstring_input_stub"

unsafe_input ~min_len ic ~pos ~len bstr similar to Bigstring.input, but does not perform any bounds checks. Will crash on bounds errors!

external unsafe_output : min_len:int -> Core_kernel.Std.out_channel -> pos:int -> len:int -> t -> int = "bigstring_output_stub"

unsafe_output ~min_len oc ~pos ~len bstr similar to Bigstring.output, but does not perform any bounds checks. Will crash on bounds errors!