Struct BocHeader

pub struct BocHeader<'a, S = RandomState> { /* private fields */ }

Intermediate BOC serializer state.

Implementations

impl<'a, S> BocHeader<'a, S>

where S: BuildHasher + Default,

pub fn with_root(root: &'a DynCell) -> Self

Creates an intermediate BOC serializer state with a single root.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty intermediate BOC serializer state. Reserves space for the specified number of cells.

pub fn with_capacity_and_root(capacity: usize, root: &'a DynCell) -> Self

Creates an intermediate BOC serializer state with a single root. Reserves space for the specified number of cells.

impl<'a, S> BocHeader<'a, S>

where S: BuildHasher,

pub fn with_root_and_cache(root: &'a DynCell, cache: BocHeaderCache<S>) -> Self

Creates an intermediate BOC serializer state with a single root and preallocated revs cache.

pub fn into_cache(self) -> BocHeaderCache<S>

Transforms BocHeader into reusable revs cache.

pub fn clear(&mut self)

Clears the header, removing all cells. Keeps the allocated memory for reuse.

pub fn add_root(&mut self, root: &'a DynCell)

Adds an additional root to the state.

pub fn with_crc(self, include_ctc: bool) -> Self

Includes CRC bytes in the encoded BOC.

pub fn without_hashes(self, without_hashes: bool) -> Self

Prevents hashes from being stored in the encoded BOC.

(overwrites descriptor flag store_hashes during serialization).

pub fn encode(&self, target: &mut Vec<u8>)

Encodes cell trees into bytes.

pub fn encode_to_writer<W: Write>(&self, writer: W) -> Result<()>

Writes cell trees into the writer.

NOTE: Use BocHeader::encode when possible since it’s faster.

pub fn compute_stats(&self) -> BocHeaderStats

Computes the encoded BOC size and other stuff.

Trait Implementations

impl<S: BuildHasher + Default> Default for BocHeader<'_, S>

fn default() -> Self

Returns the “default value” for a type.