shuttle 0.9.4 (latest) · OCaml Package

Extensible buffers using bigstrings.

type t

val sexp_of_t : t -> Sexplib0.Sexp.t

exception Maximum_buffer_size_exceeded of {

current_length : int;
new_length_requested : int;

}

val create : ?max_buffer_size:int -> int -> t

create ?max_buffer_size size returns a new empty bytebuffer. The bytebuffer will be resized automatically, up-to max_buffer_size, if attempting to add more than size characters to the bytebuffer. max_buffer_size defaults to Int.max_value.

val compact : t -> unit

val available_to_write : t -> int

val ensure_space : t -> int -> unit

val length : t -> int

length returns the number of characters in the bytebuffer.

val capacity : t -> int

capacity is the size of the underlying bigstring.

val max_buffer_size : t -> int

max_buffer_size is the maximum size that the underlying buffer can grow upto.

val drop : t -> int -> unit

drop n removes n bytes from the beginning of the bytebuffer. This is usually called after a user processes some data from the buffer using a view into the internal bigstring via unsafe_peek.

Raises invalid_arg if n is greater than the buffer's length.

val read : t -> Core_unix.File_descr.t -> int

read buf fd reads bytes from the file descriptor fd and appends them to the end of the bytebuffer. Returns the number of bytes actually read.

Raises Bigstring_unix.IOError in the case of input errors, or on EOF.

val write : t -> Core_unix.File_descr.t -> int

write buf fd reads data from the beginning of the buffer and writes them to the file descriptor fd.

Returns the number of bytes actually written.

Raises Core_unix.Unix_error in case of i/o errors.

val read_assume_fd_is_nonblocking : 
  t ->
  Core_unix.File_descr.t ->
  Core_unix.Syscall_result.Int.t

read_assume_fd_is_nonblocking buf fd is similar to read but it performs the read without yielding to other OCaml-threads. This function should only be called for non-blocking file-descriptors.

Returns the number of bytes actually read.

Raises Invalid_argument if the designated range is out of bounds.

val write_assume_fd_is_nonblocking : t -> Core_unix.File_descr.t -> int

write_assume_fd_is_nonblocking buf fd is similar to write buf it performs the write without yielding to other OCaml-threads. This function should only be called for non-blocking file-descriptors.

Returns the number of bytes actually written.

Raises Core_unix.Unix_error in case of i/o errors.

val add_char : t -> char -> unit

add_char appends the charater at the end of the bytebuffer.

val add_string : t -> ?pos:int -> ?len:int -> string -> unit

add_string appends the string at the end of the bytebuffer.

val add_bytes : t -> ?pos:int -> ?len:int -> bytes -> unit

add_bytes appends the bytes at the end of the bytebuffer.

val add_bigstring : t -> ?pos:int -> ?len:int -> Core.Bigstring.t -> unit

add_bigstring appends the bigstring at the end of the bytebuffer.

val add_bytebuffer : t -> t -> unit

add_bytebuffer appends the contents of the buffer at the end of the bytebuffer.

val to_string : t -> string

to_string returns a copy of the current contents of the bytebuffer.

val unsafe_index : t -> char -> int

val unsafe_peek : t -> Slice.t

val slice : ?pos:int -> ?len:int -> t -> Slice.t

package shuttle