Struct bee_crypto::ternary::bigint::t242::BTRIT_MIN

pub struct BTRIT_MIN { /* fields omitted */ }

👎 Deprecated:

bee-crypto will not be supported in future versions. You can use functions from iota-crypto instead.

T242 balanced trits represented minimum value.

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

pub fn clear(&mut self)

Clears the buffer, removing all values. Note that this method has no effect on the allocated capacity of the buffer.

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 append<U>(&mut self, trits: &Trits<U>) where
    U: RawEncoding<Trit = <<T as RawEncodingBuf>::Slice as RawEncoding>::Trit> + ?Sized, 

Append a trit slice to the end of this TritBuf.

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 capacity(&self) -> usize

Returns the number of trits the TritBuf can hold without reallocating.

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 Trits::as_trytes.

Methods from Deref<Target = Trits<<T as RawEncodingBuf>::Slice>>

pub fn is_empty(&self) -> bool

Returns true if the trit slice is empty.

pub fn len(&self) -> usize

Returns the number of trits in this trit slice.

pub fn as_i8_slice(&self) -> &[i8]

Interpret this slice as an (core::i8) slice.

Panics

This function will panic if the slice is not byte-aligned.

pub unsafe fn get_unchecked(&self, index: usize) -> <T as RawEncoding>::Trit

Fetch the trit at the given index of this trit slice without first checking whether the index is in bounds. Providing an index that is not less than the length of this slice is undefined behaviour.

This is perhaps the ‘least bad’ unsafe function in this crate: not because any form of undefined behaviour is better or worse than another (after all, the point of undefined behaviour is that it is undefined) but because it’s the easiest to use correctly.

Safety

An index with a value less then the result of Trits::len must be used. Any other value is undefined behaviour.

pub fn get(&self, index: usize) -> Option<<T as RawEncoding>::Trit>

Fetch the trit at the given index of this trit slice, if the index is valid.

pub fn iter(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Returns an iterator over the trits in this slice.

Using this function is significantly faster than calling Trits::get in a loop and should be used where possible.

pub fn subslice(&self, range: Range<usize>) -> &Trits<T>

Returns a subslice of this slice with the given range of trits.

Panics

This function will panic if called with a range that contains indices outside this slice, or the start of the range is greater than its end.

pub fn to_buf<U>(&self) -> TritBuf<U> where
    U: RawEncodingBuf<Slice = T>, 

Copy the contents of this trit slice into a new TritBuf with the same encoding. This function is analogous to to_vec method implemented on ordinary slices.

pub fn chunks(
    &self,
    chunk_len: usize
) -> impl DoubleEndedIterator + ExactSizeIterator

Return an iterator over distinct, non-overlapping subslices of this trit slice, each with the given chunk length. If the length of the trit slice is not a multiple of the given chunk length, the last slice provided by the iterator will be smaller to compensate.

Panics

This function will panic if the given chunk length is 0.

pub fn encode<U>(&self) -> TritBuf<U> where
    U: RawEncodingBuf,
    <U as RawEncodingBuf>::Slice: RawEncoding,
    <<U as RawEncodingBuf>::Slice as RawEncoding>::Trit == <T as RawEncoding>::Trit, 

Encode the contents of this trit slice into a TritBuf with a different encoding.

pub fn iter_trytes(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Returns an iterator over the trytes represented within this slice.

For encodings that are representation-compatible with trytes, such as T3B1, use Trits::as_trytes instead since it is faster and more capable.

pub fn as_raw_slice(&self) -> &[T]

View this trit slice as an ordinary slice of trits.

pub fn as_trytes(&self) -> &[Tryte]

Interpret this trit slice as a Tryte slice.

Panics

This function will panic if the length of the slice is not a multiple of 3, or if the slice is not byte-aligned.

Trait Implementations

impl Deref for BTRIT_MIN

type Target = T242<Btrit>

The resulting type after dereferencing.

fn deref(&self) -> &T242<Btrit>

Dereferences the value.

impl LazyStatic for BTRIT_MIN