package octez-proto-libs

  1. Overview
  2. Docs
Octez protocol libraries

Install 

dune-project
 Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

  1. T
    Tezos devteam

Maintainers

  1. C
    contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2
sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61
sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V0/Make/MBytes/index.html

Module Make.MBytesSource

val create : int -> t
val length : t -> int
val copy : t -> t
val sub : t -> int -> int -> t

sub src ofs len extract a sub-array of src starting at ofs and of length len. No copying of elements is involved: the sub-array and the original array share the same storage space.

val blit : t -> int -> t -> int -> int -> unit

blit src ofs_src dst ofs_dst len copy len bytes from src starting at ofs_src into dst starting at ofs_dst.

val blit_of_string : string -> int -> t -> int -> int -> unit

See blit

val blit_to_bytes : t -> int -> bytes -> int -> int -> unit

See blit

val of_string : string -> t

of_string s create an byte array filled with the same content than s.

val to_string : t -> string

to_string b dump the array content in a string.

val sub_string : t -> int -> int -> string

sub_string b ofs len is equivalent to to_string (sub b ofs len).

Functions reading and writing bytes

val get_char : t -> int -> char

get_char buff i reads 1 byte at offset i as a char

val get_uint8 : t -> int -> int

get_uint8 buff i reads 1 byte at offset i as an unsigned int of 8 bits. i.e. It returns a value between 0 and 2^8-1

val get_int8 : t -> int -> int

get_int8 buff i reads 1 byte at offset i as a signed int of 8 bits. i.e. It returns a value between -2^7 and 2^7-1

val set_char : t -> int -> char -> unit

set_char buff i v writes v to buff at offset i

val set_int8 : t -> int -> int -> unit

set_int8 buff i v writes the least significant 8 bits of v to buff at offset i

Functions reading according to Big Endian byte order

val get_uint16 : t -> int -> int

get_uint16 buff i reads 2 bytes at offset i as an unsigned int of 16 bits. i.e. It returns a value between 0 and 2^16-1

val get_int16 : t -> int -> int

get_int16 buff i reads 2 byte at offset i as a signed int of 16 bits. i.e. It returns a value between -2^15 and 2^15-1

val get_int32 : t -> int -> int32

get_int32 buff i reads 4 bytes at offset i as an int32.

val get_int64 : t -> int -> int64

get_int64 buff i reads 8 bytes at offset i as an int64.

val set_int16 : t -> int -> int -> unit

set_int16 buff i v writes the least significant 16 bits of v to buff at offset i

val set_int32 : t -> int -> int32 -> unit

set_int32 buff i v writes v to buff at offset i

val set_int64 : t -> int -> int64 -> unit

set_int64 buff i v writes v to buff at offset i

module LE : sig ... end

Functions reading according to Little Endian byte order

val (=) : t -> t -> bool
val (<>) : t -> t -> bool
val (<) : t -> t -> bool
val (<=) : t -> t -> bool
val (>=) : t -> t -> bool
val (>) : t -> t -> bool
val compare : t -> t -> int
val concat : string -> t list -> t
val to_hex : t -> [ `Hex of string ]
val of_hex : [ `Hex of string ] -> t