Index of values

bitstring_length bitstring returns the length of the bitstring in bits.

bitstring_of_chan chan loads the contents of the input channel chan as a bitstring.

bitstring_of_chan_max chan max works like Bitstring.bitstring_of_chan but will only read up to max bytes from the channel (or fewer if the end of input occurs before that).

bitstring_of_file filename loads the named file into a bitstring.

bitstring_of_file_descr fd loads the contents of the file descriptor fd as a bitstring.

bitstring_of_file_descr_max fd max works like Bitstring.bitstring_of_file_descr but will only read up to max bytes from the channel (or fewer if the end of input occurs before that).

bitstring_of_string str creates a bitstring of length String.length str * 8 (bits) containing the bits in str.

bitstring_to_file bits filename writes the bitstring bits to the channel chan.

bitstring_to_file bits filename writes the bitstring bits to the file filename.

clear bits n sets the nth bit in the bitstring to 0.

compare bs1 bs2 compares two bitstrings and returns zero if they are equal, a negative number if bs1 < bs2, or a positive number if bs1 > bs2.

Concatenate a list of bitstrings together into a single bitstring.

create_bitstring n creates an n bit bitstring containing all zeroes.

Create a constructor field.

Create a pattern field.

Set this variable to true to enable extended debugging.

Drop the first n bits of the bitstring and return a new bitstring which is shorter by n bits.

empty_bitstring is the empty, zero-length bitstring.

equals returns true if and only if the two bitstrings are semantically equal.

get bits n returns the nth bit (returns non-zero or 0).

Get the bind expression of a field, or None if there is none.

Get the check expression of a field, or None if there is none.

Get the endianness of a field.

Get the expression from an expression field.

Get the length in bits from a field.

Get the source code location of a field.

Get the offset expression of a field, or None if there is none.

Get the pattern from a pattern field.

Get the save_offset_to pattern of a field, or None if there is none.

Get the signedness of a field.

Get the type of a field, Int, String or Bitstring.

hexdump_bitstring chan bitstring prints the bitstring to the output channel in a format similar to the Unix command hexdump -C.

is_clear bits n is true if the nth bit is set to 0.

Tests if the bitstring is all one bits (cf.

is_set bits n is true if the nth bit is set to 1.

Tests if the bitstring is all zero bits (cf.

make_bitstring n c creates an n bit bitstring containing the repeated 8 bit pattern in c.

Load a pattern/constructor from an output channel.

Load a pattern/constructor from a string at offset within the string.

Serialize a pattern/constructor to part of a string, return the length.

Save a pattern/constructor to an output channel.

Serialize a pattern/constructor to a string.

ones_bitstring creates an n bit bitstring of all 1's.

The package name, always "ocaml-bitstring"

put bits n v sets the nth bit in the bitstring to 1 if v is not zero, or to 0 if v is zero.

set bits n sets the nth bit in the bitstring to 1.

Set the bind-expression for a field to the given expression.

Set the check expression for a field to the given expression.

Sets the endianness of a field to the constant endianness.

Sets the endianness of a field to an endianness expression.

Sets the expression field to an arbitrary OCaml expression.

Sets the expression to the value of the integer.

Sets the pattern field to the pattern which matches an integer.

Sets the length in bits of a field to an OCaml expression.

Sets the length in bits of a field to a constant integer.

Sets the expression in a constructor field to an expression which uses the identifier.

Sets the pattern to the pattern binding an identifier given in the string.

Sets the source code location of a field.

Remove the bind-expression from a field.

Remove the check expression from a field.

Remove the offset expression from a field.

Remove the save_offset_to from a field.

Set the offset expression for a field to the given expression.

Set the offset expression for a field to the given number.

Sets the pattern field to an arbitrary OCaml pattern match.

Set the save_offset_to pattern for a field to the given pattern.

Set the save_offset_to pattern for a field to identifier.

Sets the signedness of a field to a constant signedness.

Sets the expression to the value of the string.

Sets the pattern field to the pattern which matches a string.

Sets the type of a field to bitstring.

Sets the type of a field to int.

Sets the type of a field to string.

Sets the pattern field to the unbound pattern (usually written _).

string_of_bitstring bitstring converts a bitstring to a string (eg.

Convert patterns, constructors or individual fields into printable strings for debugging purposes.

Endianness.

subbitstring bits off len returns a sub-bitstring of the bitstring, starting at offset off bits and with length len bits.

Take the first n bits of the bitstring and return a new bitstring which is exactly n bits long.

The package version as a string.

zeroes_bitstring creates an n bit bitstring of all 0's.