Struct UnorderedSetMapper

pub struct UnorderedSetMapper<SA, T, A = CurrentStorage>
where
    SA: StorageMapperApi,
    A: StorageAddress<SA>,
    T: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static,
{ /* private fields */ }

Implementations

impl<SA, T, A> UnorderedSetMapper<SA, T, A>

where SA: StorageMapperApi, A: StorageAddress<SA>, T: TopEncode + TopDecode + NestedEncode + NestedDecode,

pub fn get_index(&self, value: &T) -> usize

Gets the item’s index at the given address’ mapper. Returns 0 if the item is not in the list.

pub fn get_by_index(&self, index: usize) -> T

Get item at index from the given address. Index must be valid (1 <= index <= count).

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

pub fn len(&self) -> usize

Returns the number of elements in the set.

pub fn contains(&self, value: &T) -> bool

Returns true if the set contains a value.

pub fn iter(&self) -> Iter<'_, SA, T, A>

An iterator visiting all elements in arbitrary order. The iterator element type is &'a T.

impl<SA, T> UnorderedSetMapper<SA, T>

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

pub fn insert(&mut self, value: T) -> bool

Adds a value to the set.

If the set did not have this value present, true is returned.

If the set did have this value present, false is returned.

pub fn swap_remove(&mut self, value: &T) -> bool

Removes a value from the set. Returns whether the value was present in the set.

pub fn swap_indexes(&mut self, index1: usize, index2: usize) -> bool

Exchanges the indexes of two values. Returns whether the operation was successful.

Trait Implementations

impl<SA, T> Extend<T> for UnorderedSetMapper<SA, T>

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

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = T>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a, SA, T, A> IntoIterator for &'a UnorderedSetMapper<SA, T, A>

where SA: StorageMapperApi, A: StorageAddress<SA>, T: TopEncode + TopDecode + NestedEncode + NestedDecode + 'static,

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<'a, SA, T, A>

Which kind of iterator are we turning this into?

fn into_iter( self, ) -> <&'a UnorderedSetMapper<SA, T, A> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<SA, T> StorageClearable for UnorderedSetMapper<SA, T>

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

fn clear(&mut self)

Clears all the entries owned by the storage.

impl<SA, T> StorageMapper<SA> for UnorderedSetMapper<SA, T>

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

fn new(base_key: StorageKey<SA>) -> UnorderedSetMapper<SA, T>

Will be called automatically by the #[storage_mapper] annotation generated code.

impl<SA, T> StorageMapperFromAddress<SA> for UnorderedSetMapper<SA, T, ManagedAddress<SA>>

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

fn new_from_address( address: ManagedAddress<SA>, base_key: StorageKey<SA>, ) -> UnorderedSetMapper<SA, T, ManagedAddress<SA>>

Will be called automatically by the #[storage_mapper_from_address] annotation generated code.

impl<SA, T> TopEncodeMulti for UnorderedSetMapper<SA, T>

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

Behaves like a MultiResultVec when an endpoint result.

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<SA, T> TypeAbi for UnorderedSetMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode + NestedEncode + NestedDecode + TypeAbi,

Behaves like a MultiResultVec when an endpoint result.

type Unmanaged = UnorderedSetMapper<SA, T>

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<SA, T> TypeAbiFrom<UnorderedSetMapper<SA, T>> for MultiValueEncoded<SA, T>

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

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

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