Struct bee_crypto::ternary::bigint::t242::T242

pub struct T242<T: Trit>(_);

Fixed size trit buffer.

Implementations

impl<T: Trit> T242<T>

pub fn new(trits_buf: TritBuf<T1B1Buf<T>>) -> Self

Creates a new fixed size trit buffer from input.

pub fn zero() -> Self

Creates a new trit buffer that represents the value 0.

pub fn into_inner(self) -> TritBuf<T1B1Buf<T>>

Transforms into its inner trit buffer.

impl<T> T242<T> where
    T: Trit,
    <T as ShiftTernary>::Target: Trit, 

pub fn into_shifted(self) -> T242<<T as ShiftTernary>::Target>

Transforms into a shifted representation of the trit buffer.

impl T242<Btrit>

pub fn one() -> Self

Creates a new balanced trit buffer that represents the value 1.

pub fn neg_one() -> Self

Creates a new balanced trit buffer that represents the value -1.

pub fn max() -> Self

Creates a new balanced trit buffer that represents the maximum value.

pub fn min() -> Self

Creates a new balanced trit buffer that represents the minimum value.

impl T242<Utrit>

pub fn one() -> Self

Creates a new unbalanced trit buffer that represents the value 1.

pub fn two() -> Self

Creates a new unbalanced trit buffer that represents the value 2.

pub fn half_max() -> Self

Creates a new unbalanced trit buffer that represents the half of the maximum value.

pub fn max() -> Self

Creates a new unbalanced trit buffer that represents the maximum value.

pub fn min() -> Self

Creates a new unbalanced trit buffer that represents the minimum value.

impl<T: Trit> T242<T>

pub fn into_t243(self) -> T243<T>

Converts the T242 to a T243.

impl T242<Btrit>

pub fn from_i384_ignoring_mst(value: I384<BigEndian, U8Repr>) -> Self

Converts a big-endian u8 represented I384 to a balanced T242 while ignoring its MST.

pub fn try_from_i384(value: I384<LittleEndian, U32Repr>) -> Result<Self, Error>

Tries to convert a big-endian u32 represented I384 to a balanced T242.

impl T242<Utrit>

pub fn from_u384_be_u8repr_ignoring_msd(value: U384<BigEndian, U8Repr>) -> Self

Converts a big-endian u8 represented U384 to an unbalanced T242 while ignoring its MSB.

pub fn try_from_i384(value: I384<LittleEndian, U32Repr>) -> Result<Self, Error>

Tries to convert a little-endian u32 represented I384 to an unbalanced T242.

Methods from Deref<Target = TritBuf<T1B1Buf<T>>>

pub fn push(
    &mut self,
    trit: <<T as RawEncodingBuf>::Slice as RawEncoding>::Trit
)

Push a trit to the back of this TritBuf.

pub fn pop(
    &mut self
) -> Option<<<T as RawEncodingBuf>::Slice as RawEncoding>::Trit>

Pop a trit from the back of this TritBuf, returning it if successful.

pub fn as_slice(&self) -> &Trits<<T as RawEncodingBuf>::Slice>

Extracts a trit slice containing the data within this buffer.

Note that TritBuf dereferences to Trits anyway, so it's usually sufficient to take a reference to TritBuf or to just call &Trits methods on it rather than explicitly calling this method first.

pub fn as_slice_mut(&mut self) -> &mut Trits<<T as RawEncodingBuf>::Slice>

Extracts a mutable trit slice containing the data within this buffer.

Note that TritBuf dereferences to Trits anyway, so it's usually sufficient to take a reference to TritBuf or to just call &mut Trits methods on it rather explicitly calling this method first.

pub fn pad_zeros(&mut self)

Pad the trit buffer with Btrit::Zero until the buffer's length is a multiple of 3.

This method is often used in conjunction with [Trites::as_trytes].

Trait Implementations

impl<T: Clone + Trit> Clone for T242<T>

fn clone(&self) -> T242<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Trit> Debug for T242<T>

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

Formats the value using the given formatter.

impl<T: Trit> Default for T242<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Trit> Deref for T242<T>

type Target = TritBuf<T1B1Buf<T>>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Trit> DerefMut for T242<T>

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

Mutably dereferences the value.

impl<T: Trit> Eq for T242<T>

impl From<T242<Btrit>> for I384<BigEndian, U8Repr>

fn from(value: T242<Btrit>) -> Self

Performs the conversion.

impl From<T242<Btrit>> for I384<BigEndian, U32Repr>

fn from(value: T242<Btrit>) -> Self

Performs the conversion.

impl From<T242<Btrit>> for I384<LittleEndian, U32Repr>

fn from(value: T242<Btrit>) -> Self

Performs the conversion.

impl<T: Trit> From<T242<T>> for T243<T>

fn from(value: T242<T>) -> Self

Performs the conversion.

impl From<T242<Utrit>> for U384<LittleEndian, U32Repr>

fn from(value: T242<Utrit>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u32; 12]>> for T242<Utrit>

fn from(binary_value: U384<LittleEndian, U32Repr>) -> Self

Performs the conversion.

impl<T: Trit> Ord for T242<T>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: Trit> PartialEq<T242<T>> for T242<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Trit> PartialOrd<T242<T>> for T242<T>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl TryFrom<I384<BigEndian, [u32; 12]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<BigEndian, U32Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<BigEndian, [u8; 48]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<BigEndian, U8Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<LittleEndian, [u32; 12]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<LittleEndian, U32Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<LittleEndian, [u8; 48]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<LittleEndian, U8Repr>) -> Result<Self, Self::Error>

Performs the conversion.