Struct MultiValueEncodedCounted

pub struct MultiValueEncodedCounted<M, T>
where
    M: ManagedTypeApi,
    T: TopDecodeMultiLength,
{ /* private fields */ }

A multi-value container, that keeps raw values as ManagedBuffer, and which encodes and decodes its length explicitly.

It allows encoding and decoding of multi-values. Its multi-encoding always starts with the number of items.

Since items are kept raw, the item type does not need to implement ManagedVecItem.

Behavior:

• It is lazy when decoding, in that it keeps them raw and will not decode the values until they are requested.
• It is eager when encoding, items are serialized before being added to this structure.

Item length

Its item type must implement TopDecodeMultiLength, which is a length marker for multi-values.

Some examples for TopDecodeMultiLength:

• MultiValue3 has a “multi-length” of 3
• a simple type, like i32, has a “multi-length” of 1
• MultiValueEncoded has no known “multi-length”, and therefore cannot be used inside MultiValueEncodedCounted.

MultiValueEncodedCounted requires this “multi-length” to determine the number of buffers needed to store the encoded values.

More specifically, the number of buffers (raw length) is equal to the item count multiplied by the item “multi-length”.

Implementations

impl<M, T> MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi, T: TopDecodeMultiLength,

pub fn new() -> Self

impl<M, T> MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti + TopDecodeMultiLength,

pub fn push(&mut self, item: T)

impl<M> MultiValueEncodedCounted<M, ManagedBuffer<M>>

where M: ManagedTypeApi,

pub fn into_vec_of_buffers(self) -> ManagedVec<M, ManagedBuffer<M>>

impl<M, T> MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMultiLength,

pub fn raw_len(&self) -> usize

Length of the underlying data.

Note: In general, it is not the number of items that can be decoded. It is the same as len() only for single encode items.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Number of items. Only available for multi-encode items.

impl<M, T> MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: ManagedVecItem + TopDecode + TopDecodeMultiLength,

pub fn to_vec(&self) -> ManagedVec<M, T>

Trait Implementations

impl<M, T> Clone for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + Clone, T: TopDecodeMultiLength + Clone,

fn clone(&self) -> MultiValueEncodedCounted<M, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, T> Debug for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + Debug, T: TopDecodeMultiLength + Debug,

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

Formats the value using the given formatter.

impl<M, T> Default for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + Default, T: TopDecodeMultiLength + Default,

fn default() -> MultiValueEncodedCounted<M, T>

Returns the “default value” for a type.

impl<M, V> FromIterator<V> for MultiValueEncodedCounted<M, V>

where M: ManagedTypeApi, V: TopEncodeMulti + TopDecodeMultiLength,

fn from_iter<T: IntoIterator<Item = V>>(iter: T) -> Self

Creates a value from an iterator.

impl<M, T> IntoIterator for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMulti + TopDecodeMultiLength,

type Item = T

The type of the elements being iterated over.

type IntoIter = MultiValueEncodedIterator<M, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<M, T> PartialEq for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + PartialEq, T: TopDecodeMultiLength + PartialEq,

fn eq(&self, other: &MultiValueEncodedCounted<M, T>) -> 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<M, T> TopDecodeMulti for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMulti + TopDecodeMultiLength,

fn multi_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<Self, H::HandledErr>

where I: TopDecodeMultiInput, H: DecodeErrorHandler,

const IS_SINGLE_VALUE: bool = false

Used to optimize single value loading of endpoint arguments.

fn multi_decode<I>(input: &mut I) -> Result<Self, DecodeError>

where I: TopDecodeMultiInput,

impl<M, T> TopEncodeMulti for &MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti + TopDecodeMultiLength,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeMultiOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn multi_encode<O>(&self, output: &mut O) -> Result<(), EncodeError>

where O: TopEncodeMultiOutput,

Attempt to serialize the value to ouput.

impl<M, T> TopEncodeMulti for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti + TopDecodeMultiLength,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeMultiOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn multi_encode<O>(&self, output: &mut O) -> Result<(), EncodeError>

where O: TopEncodeMultiOutput,

Attempt to serialize the value to ouput.

impl<M, T> TypeAbi for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi, T: TypeAbi + TopDecodeMultiLength,

type Unmanaged = MultiValueVec<<T as TypeAbi>::Unmanaged>

fn type_name() -> TypeName

fn type_name_rust() -> TypeName

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC, )

A type can provide more than its own name. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

fn type_names() -> TypeNames

impl<M, T> StructuralPartialEq for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi, T: TopDecodeMultiLength,

impl<M, T> TypeAbiFrom<&MultiValueEncodedCounted<M, T>> for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi, T: TypeAbi + TopDecodeMultiLength,

impl<M, T> TypeAbiFrom<MultiValueEncodedCounted<M, T>> for MultiValueEncodedCounted<M, T>

where M: ManagedTypeApi, T: TypeAbi + TopDecodeMultiLength,

impl<M, T, U> TypeAbiFrom<MultiValueEncodedCounted<M, T>> for MultiValueVec<U>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti + TopDecodeMultiLength, U: TypeAbiFrom<T>,

impl<M, T, U> TypeAbiFrom<MultiValueVec<T>> for MultiValueEncodedCounted<M, U>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti, U: TypeAbiFrom<T> + TopDecodeMultiLength,