Struct LimitedVec

pub struct LimitedVec<T, E, const N: usize>(/* private fields */);

Limited len vector. T is data type. E is overflow error type. N is max len which a vector can have.

Implementations

impl<T: Clone + Default, E: Default, const N: usize> LimitedVec<T, E, N>

pub const fn new() -> Self

Constructs a new, empty LimitedVec<T>.

pub fn try_new_default(len: usize) -> Result<Self, E>

Tries to create new limited vector of length len with default initialized elements.

pub fn new_default() -> Self

Creates new limited vector with default initialized elements.

pub fn filled_with(value: T) -> Self

Creates limited vector filled with the specified value.

pub fn extend_with(&mut self, value: T)

Extends the array to its limit and fills with the specified value.

pub fn try_push(&mut self, value: T) -> Result<(), E>

Append value to the end of vector.

pub fn try_extend_from_slice(&mut self, values: &[T]) -> Result<(), E>

Append values to the end of vector.

pub fn try_prepend(&mut self, values: Self) -> Result<(), E>

Append values to the begin of vector.

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

Returns ref to the internal data.

pub fn inner_mut(&mut self) -> &mut [T]

Returns mut ref to the internal data slice.

pub fn into_vec(self) -> Vec<T>

Destruct limited vector and returns inner vector.

pub const fn max_len() -> usize

Returns max len which this type of limited vector can have.

impl LimitedVec<u8, PayloadSizeError, MAX_PAYLOAD_SIZE>

pub fn len_u32(&self) -> u32

Get payload length as u32.

Trait Implementations

impl<T: Clone, E: Clone, const N: usize> Clone for LimitedVec<T, E, N>

fn clone(&self) -> LimitedVec<T, E, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone + Default, E: Default, const N: usize> Debug for LimitedVec<T, E, N>

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

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

Formats the value using the given formatter.

impl<T, E, const N: usize> Decode for LimitedVec<T, E, N>

where Vec<T>: Decode, PhantomData<E>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Default, E: Default, const N: usize> Default for LimitedVec<T, E, N>

fn default() -> LimitedVec<T, E, N>

Returns the “default value” for a type.

impl<T: Clone + Default, E: Default, const N: usize> Display for LimitedVec<T, E, N>

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

Formatter for LimitedVec will print to precision of 8 by default, to print the whole data, use {:+}.

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

Formats the value using the given formatter.

impl<T, E, const N: usize> Encode for LimitedVec<T, E, N>

where Vec<T>: Encode, PhantomData<E>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Hash, E: Hash, const N: usize> Hash for LimitedVec<T, E, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, E: Ord, const N: usize> Ord for LimitedVec<T, E, N>

fn cmp(&self, other: &LimitedVec<T, E, N>) -> 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<T: PartialEq, E: PartialEq, const N: usize> PartialEq for LimitedVec<T, E, N>

fn eq(&self, other: &LimitedVec<T, E, N>) -> 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<T: PartialOrd, E: PartialOrd, const N: usize> PartialOrd for LimitedVec<T, E, N>

fn partial_cmp(&self, other: &LimitedVec<T, E, N>) -> 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<T, E: Default, const N: usize> TryFrom<Vec<T>> for LimitedVec<T, E, N>

type Error = E

The type returned in the event of a conversion error.

fn try_from(x: Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, E, const N: usize> TypeInfo for LimitedVec<T, E, N>

where Vec<T>: TypeInfo + 'static, PhantomData<E>: TypeInfo + 'static, T: TypeInfo + 'static, E: TypeInfo + 'static,

type Identity = LimitedVec<T, E, N>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T, E, const N: usize> EncodeLike for LimitedVec<T, E, N>

where Vec<T>: Encode, PhantomData<E>: Encode,

impl<T: Eq, E: Eq, const N: usize> Eq for LimitedVec<T, E, N>

impl<T, E, const N: usize> StructuralPartialEq for LimitedVec<T, E, N>