package octez-libs
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13
doc/octez-libs.lazy-containers/Tezos_lazy_containers/Immutable_chunked_byte_vector/index.html
Module Tezos_lazy_containers.Immutable_chunked_byte_vector
Source
Chunked byte vector
val create :
?origin:Tezos_tree_encoding.wrapped_tree ->
?get_chunk:(int64 -> Chunk.t Lwt.t) ->
int64 ->
t
create length
creates a chunked byte vector that has capacity for length
bytes.
Note: This function is expected to be used only by the tree-encoding library. To create a brand new chunked byte vector, use allocate
.
origin vec
returns the tree of origin of the vector, if it exists.
Note: The sole consumer of this function is expected to be the tree-encoding library.
allocate len
creates a new zeroed chunked byte vector.
Note: This function may be dangerous to use in a tick if len
is too large.
of_bytes bytes
creates a chunked byte vector from the given bytes
. The underlying memory is effectively copied - further modifications to bytes
are not reflected in the chunked byte vector. Use this over of_string
when turning your bytes
into a string
would be potentially expensive.
grow vector length_delta
creates a new vector with the byte vector length increased by length_delta
and initializes the memory with empty chunks.
Note: This function may be dangerous to use in a tick if length_delta
is too large.
load_bytes vector offset num_bytes
loads the bytes at offset
to offset + num_bytes
.
Note: This function may be dangerous to use in a tick if num_bytes
is too large.
store_byte vector offset byte
creates a new vector with the byte at offset
set to byte
.
store_bytes vector offset bytes
creates a new vector with the bytes from offset
set to the given bytes
.
loaded_chunks vector
returns the chunks of vector
that have been cached in-memory since vector
has been created, either by reading its contents, or by writing to those chunks.
encoding
is a Tezos_tree_encoding
for t
.