package octez-proto-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V8/Make/Hex/index.html
Module Make.Hex
Source
Hexadecimal encoding.
Hex
defines hexadecimal encodings for characters, strings and Cstruct.t buffers.
Characters
to_char x y
is the character corresponding to the xy
hexadecimal encoding.
Returns None
if x
or y
are not in the ranges '0'..'9'
, 'a'..'f'
, or 'A'..'F'
.
Strings
val of_string : ?ignore:char list -> string -> t
of_string s
is the hexadecimal representation of the binary string s
. If ignore
is set, skip the characters in the list when converting. Eg of_string ~ignore:[' '] "a f"
. The default value of ignore
is []
).
val to_string : t -> string option
to_string t
is the binary string s
such that of_string s
is t
.
Returns None
if t
contains a character that is not in the range '0'..'9'
, 'a'..'f'
, or 'A'..'F'
.
Bytes
val of_bytes : ?ignore:char list -> bytes -> t
of_bytes s
is the hexadecimal representation of the binary string s
. If ignore
is set, skip the characters in the list when converting. Eg of_bytes ~ignore:[' '] "a f"
. The default value of ignore
is []
).
val to_bytes : t -> bytes option
to_bytes t
is the binary string s
such that of_bytes s
is t
.
Returns None
if t
contains a character that is not in the range '0'..'9'
, 'a'..'f'
, or 'A'..'F'
.
Debugging
val hexdump_s : ?print_row_numbers:bool -> ?print_chars:bool -> t -> string
Same as hexdump
except returns a string.
Pretty printing
val pp : Format.formatter -> t -> unit
pp fmt t
will output a human-readable hex representation of t
to the formatter fmt
.
val show : t -> string
show t
will return a human-readable hex representation of t
as a string.