Struct MultiValueEncoded

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

A multi-value container, that keeps raw values as ManagedBuffer It allows encoding and decoding of multi-values.

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.

Since it can contain multi-values, the number of actual items it contains cannot be determined without fully decoding.

Implementations

impl<M, T> MultiValueEncoded<M, T>

where M: ManagedTypeApi,

pub fn new() -> MultiValueEncoded<M, T>

impl<M, T> MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti,

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

impl<M, T> MultiValueEncoded<M, T>

where M: ManagedTypeApi,

pub fn to_arg_buffer(&self) -> ManagedArgBuffer<M>

impl<M> MultiValueEncoded<M, ManagedBuffer<M>>

where M: ManagedTypeApi,

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

impl<M, T> MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi,

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

impl<M, T> MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMultiLength,

pub fn len(&self) -> usize

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

impl<M, T> MultiValueEncoded<M, T>

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

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

Trait Implementations

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

where M: Clone + ManagedTypeApi, T: Clone,

fn clone(&self) -> MultiValueEncoded<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 MultiValueEncoded<M, T>

where M: Debug + ManagedTypeApi, T: Debug,

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

Formats the value using the given formatter.

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

where M: Default + ManagedTypeApi, T: Default,

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

Returns the “default value” for a type.

impl<M, T> From<ManagedVec<M, T>> for MultiValueEncoded<M, T>

where M: ManagedTypeApi, T: ManagedVecItem + TopEncode + 'static,

fn from(v: ManagedVec<M, T>) -> MultiValueEncoded<M, T>

Converts to this type from the input type.

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

where M: ManagedTypeApi, V: TopEncodeMulti,

fn from_iter<T>(iter: T) -> MultiValueEncoded<M, V>

where T: IntoIterator<Item = V>,

Creates a value from an iterator.

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

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMulti,

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) -> <MultiValueEncoded<M, T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

where M: PartialEq + ManagedTypeApi, T: PartialEq,

fn eq(&self, other: &MultiValueEncoded<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 MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopDecodeMulti,

fn multi_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<MultiValueEncoded<M, T>, <H as DecodeErrorHandler>::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 &MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::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 MultiValueEncoded<M, T>

where M: ManagedTypeApi + ErrorApi, T: TopEncodeMulti,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::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 MultiValueEncoded<M, T>

where M: ManagedTypeApi, T: TypeAbi,

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

fn type_name() -> String

fn type_name_rust() -> String

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

where TDC: TypeDescriptionContainer,

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 MultiValueEncoded<M, T>

where M: ManagedTypeApi,

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

where M: ManagedTypeApi, T: TypeAbi,

impl<SA, K, V> TypeAbiFrom<BiDiMapper<SA, K, V>> for MultiValueEncoded<SA, MultiValue2<K, V>>

where SA: StorageMapperApi, K: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static + Default + PartialEq, V: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static + Default + PartialEq,

impl<SA, T, U> TypeAbiFrom<LinkedListMapper<SA, T>> for MultiValueEncoded<SA, U>

where SA: StorageMapperApi, T: TopEncode + TopDecode + NestedEncode + NestedDecode + Clone, U: TypeAbiFrom<T>,

impl<SA, K, V> TypeAbiFrom<MapMapper<SA, K, V>> for MultiValueEncoded<SA, MultiValue2<K, V>>

where SA: StorageMapperApi, K: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static, V: TopEncode + TopDecode + 'static,

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

where M: ManagedTypeApi, T: TypeAbi,

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

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

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

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

impl<SA, T> TypeAbiFrom<QueueMapper<SA, T>> for MultiValueEncoded<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode,

impl<SA, T> TypeAbiFrom<SetMapper<SA, T>> for MultiValueEncoded<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static,

impl<SA> TypeAbiFrom<UniqueIdMapper<SA>> for MultiValueEncoded<SA, usize>

where SA: StorageMapperApi,

impl<SA, T> TypeAbiFrom<UnorderedSetMapper<SA, T>> for MultiValueEncoded<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static,

impl<SA> TypeAbiFrom<UserMapper<SA>> for MultiValueEncoded<SA, ManagedAddress<SA>>

where SA: StorageMapperApi,

impl<SA, T> TypeAbiFrom<VecMapper<SA, T>> for MultiValueEncoded<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode,