Struct CellBuilder

pub struct CellBuilder { /* private fields */ }

Builder for constructing cells with densely packed data.

Implementations

impl CellBuilder

pub fn build_from<T>(data: T) -> Result<Cell, Error>

where T: Store,

Builds a new cell from the specified data using the default cell context.

pub fn build_from_ext<T>( data: T, context: &dyn CellContext, ) -> Result<Cell, Error>

where T: Store,

Builds a new cell from the specified data using the provided cell context.

pub fn build_library<T: AsRef<[u8; 32]>>(hash: &T) -> Cell

Builds a new library cell referencing the specified library.

Uses the default cell context.

pub fn build_library_ext<T: AsRef<[u8; 32]>>( hash: &T, context: &dyn CellContext, ) -> Cell

Builds a new library cell referencing the specified library.

Uses the specified cell context.

pub const fn new() -> Self

Creates an empty cell builder.

pub fn from_raw_data(value: &[u8], bits: u16) -> Result<Self, Error>

Tries to create a cell builder with the specified data.

NOTE: if bits is greater than bytes * 8, pads the value with zeros (as high bits).

pub fn from_parts( is_exotic: bool, data: CellDataBuilder, refs: CellRefsBuilder, ) -> Self

Creates a cell builder from its inner parts.

pub fn into_parts(self) -> (bool, CellDataBuilder, CellRefsBuilder)

Splits cell builder into its inner parts.

pub fn as_full_slice(&self) -> CellSlice<'_>

Returns a slice which contains builder data and references.

NOTE: intermediate cell hash is undefined.

pub const fn size(&self) -> Size

Returns the stored cell size.

pub const fn size_refs(&self) -> u8

Returns child cell count.

pub const fn spare_capacity(&self) -> Size

Returns the remaining capacity in bits and references.

pub const fn spare_capacity_refs(&self) -> u8

Returns remaining references capacity.

pub const fn has_capacity(&self, bits: u16, refs: u8) -> bool

Returns true if there is enough remaining capacity to fit bits and refs.

pub const fn is_exotic(&self) -> bool

Returns whether this cell will be built as an exotic.

pub fn set_exotic(&mut self, is_exotic: bool)

Marks this cell as exotic.

pub fn references(&self) -> &[Cell]

Returns a slice of the child cells stored in the builder.

pub fn store_reference(&mut self, cell: Cell) -> Result<(), Error>

Tries to store a child in the cell, returning false if there is not enough remaining capacity.

pub fn set_references(&mut self, refs: CellRefsBuilder)

Sets children of the cell.

pub fn store_builder(&mut self, builder: &Self) -> Result<(), Error>

Tries to append a builder (its data and references), returning false if there is not enough remaining capacity.

pub fn store_slice<'a, T>(&mut self, value: T) -> Result<(), Error>

where T: AsRef<CellSlice<'a>>,

Tries to append a cell slice (its data and references), returning false if there is not enough remaining capacity.

pub fn build_ext(self, context: &dyn CellContext) -> Result<Cell, Error>

Tries to build a new cell using the specified cell context.

pub fn build(self) -> Result<Cell, Error>

Tries to build a new cell using the default cell context.

See empty_context

Methods from Deref<Target = CellDataBuilder>

pub fn as_data_slice(&self) -> CellSlice<'_>

Returns a slice which contains only builder data bits and no references.

NOTE: intermediate cell hash is undefined.

pub fn display_data(&self) -> DisplayCellBuilderData<'_>

Returns an object which will display data as a bitstring with a termination bit.

pub fn as_bitstring(&self) -> Bitstring<'_>

Returns cell data as a Bitstring.

pub fn raw_data(&self) -> &[u8; 128]

Returns an underlying cell data.

pub fn size_bits(&self) -> u16

Returns the data size of this cell in bits.

pub fn spare_capacity_bits(&self) -> u16

Returns remaining data capacity in bits.

pub fn has_capacity_bits(&self, bits: u16) -> bool

Returns true if there is enough remaining capacity to fit bits.

pub fn clear_bits(&mut self)

Clears all data bits and sets the size in bits to 0.

pub fn rewind_bits(&mut self, bits: u16) -> Result<(), Error>

Removes the specified amount of bits from the end of the data.

pub fn store_zeros(&mut self, bits: u16) -> Result<(), Error>

Tries to store the specified number of zero bits in the cell, returning false if there is not enough remaining capacity.

pub fn store_ones(&mut self, bits: u16) -> Result<(), Error>

Tries to store the specified number of set bits in the cell, returning false if there is not enough remaining capacity.

pub fn store_bit_zero(&mut self) -> Result<(), Error>

Tries to store one zero bit in the cell, returning false if there is not enough remaining capacity.

pub fn store_bit_one(&mut self) -> Result<(), Error>

Tries to store one non-zero bit in the cell, returning false if there is not enough remaining capacity.

pub fn store_bit(&mut self, value: bool) -> Result<(), Error>

Tries to store one bit in the cell, returning false if there is not enough remaining capacity.

pub fn store_u8(&mut self, value: u8) -> Result<(), Error>

Tries to store u8 in the cell, returning false if there is not enough remaining capacity.

pub fn store_u16(&mut self, value: u16) -> Result<(), Error>

Tries to store u16 in the cell, returning false if there is not enough remaining capacity.

pub fn store_u32(&mut self, value: u32) -> Result<(), Error>

Tries to store u32 in the cell, returning false if there is not enough remaining capacity.

pub fn store_u64(&mut self, value: u64) -> Result<(), Error>

Tries to store u64 in the cell, returning false if there is not enough remaining capacity.

pub fn store_u128(&mut self, value: u128) -> Result<(), Error>

Tries to store u128 in the cell, returning false if there is not enough remaining capacity.

pub fn store_u256<T>(&mut self, value: &T) -> Result<(), Error>

where T: AsRef<[u8; 32]>,

Tries to store 32 bytes in the cell, returning false if there is not enough remaining capacity.

pub fn store_small_uint(&mut self, value: u8, bits: u16) -> Result<(), Error>

Tries to store u8 in the cell (but only the specified number of bits), returning false if there is not enough remaining capacity.

NOTE: if bits is greater than 8, pads the value with zeros (as high bits).

pub fn store_uint(&mut self, value: u64, bits: u16) -> Result<(), Error>

Tries to store u64 in the cell (but only the specified number of bits), returning false if there is not enough remaining capacity.

NOTE: if bits is greater than 64, pads the value with zeros (as high bits).

pub fn store_bigint( &mut self, x: &BigInt, bits: u16, signed: bool, ) -> Result<(), Error>

Stores bits-width [BigInt] to the builder.

pub fn store_bigint_truncate( &mut self, x: &BigInt, bits: u16, signed: bool, ) -> Result<(), Error>

Stores bits-width [BigInt] to the builder. x bit size is ignored and only low bits of it are written.

pub fn store_biguint( &mut self, x: &BigUint, bits: u16, signed: bool, ) -> Result<(), Error>

Stores bits-width [BigUint] to the builder.

pub fn store_biguint_truncate( &mut self, x: &BigUint, bits: u16, ) -> Result<(), Error>

Stores bits-width [BigUint] to the builder. x bit size is ignored and only low bits of it are written.

pub fn store_var_bigint( &mut self, x: &BigInt, len_bits: u16, signed: bool, ) -> Result<(), Error>

Loads variable length [BigInt] to the builder.

pub fn store_var_biguint( &mut self, x: &BigUint, len_bits: u16, ) -> Result<(), Error>

Loads variable length [BigInt] to the builder.

pub fn store_raw(&mut self, value: &[u8], bits: u16) -> Result<(), Error>

Tries to store bytes in the cell (but only the specified number of bits), returning false if there is not enough remaining capacity.

NOTE: if bits is greater than bytes * 8, pads the value with zeros (as high bits).

pub fn store_cell_data<T>(&mut self, value: T) -> Result<(), Error>

where T: AsRef<DynCell>,

Tries to store all data bits of the specified cell in the current cell, returning false if there is not enough remaining capacity.

pub fn store_slice_data<'a, T>(&mut self, value: T) -> Result<(), Error>

where T: AsRef<CellSlice<'a>>,

Tries to store the remaining slice data in the cell, returning false if there is not enough remaining capacity.

pub fn prepend_raw(&mut self, value: &[u8], bits: u16) -> Result<(), Error>

Tries to prepend bytes to the cell data (but only the specified number of bits), returning false if there is not enough capacity.

NOTE: if bits is greater than bytes * 8, pads the value with zeros (as high bits).

Trait Implementations

impl AsMut<CellDataBuilder> for CellBuilder

fn as_mut(&mut self) -> &mut CellDataBuilder

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<CellDataBuilder> for CellBuilder

fn as_ref(&self) -> &CellDataBuilder

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CellBuilder

fn clone(&self) -> CellBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CellBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CellBuilder

fn default() -> CellBuilder

Returns the “default value” for a type.

impl Deref for CellBuilder

type Target = CellDataBuilder

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for CellBuilder

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<CellDataBuilder> for CellBuilder

fn from(inner: CellDataBuilder) -> Self

Converts to this type from the input type.

impl Ord for CellBuilder

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CellBuilder

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CellBuilder

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Store for CellBuilder

fn store_into( &self, builder: &mut CellBuilder, _: &dyn CellContext, ) -> Result<(), Error>

Tries to store itself into the cell builder.

impl Eq for CellBuilder