CellBuilder

Struct CellBuilder 

Source
pub struct CellBuilder { /* private fields */ }
Expand description

Builder for constructing cells with densely packed data.

Implementations§

Source§

impl CellBuilder

Source

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.

Source

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

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

Source

pub const fn new() -> Self

Creates an empty cell builder.

Source

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).

Source

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.

Source

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

Returns a slice which contains builder data and references.

NOTE: intermediate cell hash is undefined.

Source

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

Returns an underlying cell data.

Source

pub const fn size(&self) -> Size

Returns the stored cell size.

Source

pub const fn size_bits(&self) -> u16

Returns the data size of this cell in bits.

Source

pub const fn size_refs(&self) -> u8

Returns child cell count.

Source

pub const fn spare_capacity(&self) -> Size

Returns the remaining capacity in bits and references.

Source

pub const fn spare_capacity_bits(&self) -> u16

Returns remaining data capacity in bits.

Source

pub const fn spare_capacity_refs(&self) -> u8

Returns remaining references capacity.

Source

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

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

Source

pub const fn is_exotic(&self) -> bool

Returns whether this cell will be built as an exotic.

Source

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

Marks this cell as exotic.

Source

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

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

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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).

Source

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).

Source

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).

Source

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.

Source

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.

Source

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).

Source§

impl CellBuilder

Source

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

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

Source

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.

Source

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

Sets children of the cell.

Source

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.

Source

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.

Source

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

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

Source

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

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

See empty_context

Source

pub fn display_data(&self) -> impl Display + Binary + '_

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

Trait Implementations§

Source§

impl Clone for CellBuilder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CellBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CellBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Ord for CellBuilder

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for CellBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for CellBuilder

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Eq for CellBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compares self to key and returns their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compares self to key and returns true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> EquivalentRepr<T> for T