Struct multiversx_sc::types::ManagedVec

#[repr(transparent)]
pub struct ManagedVec<M, T>where
    M: ManagedTypeApi,
    T: ManagedVecItem,{ /* private fields */ }

A list of items that lives inside a managed buffer. Items can be either stored there in full (e.g. u32), or just via handle (e.g. BigUint<M>).

Implementations

impl<M, T> ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

pub fn new() -> Self

impl<M, T> ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

pub fn byte_len(&self) -> usize

Length of the underlying buffer in bytes.

pub fn len(&self) -> usize

Number of items.

pub fn is_empty(&self) -> bool

pub fn try_get(&self, index: usize) -> Option<T::Ref<'_>>

pub fn to_array_of_refs<const N: usize>(&self) -> Option<[T::Ref<'_>; N]>

Extracts all elements to an array, if the length matches exactly.

The resulting array contains mere references to the items, as defined in ManagedVecItem.

pub fn get(&self, index: usize) -> T::Ref<'_>

Retrieves element at index, if the index is valid. Otherwise, signals an error and terminates execution.

pub fn get_mut(&mut self, index: usize) -> ManagedVecRef<'_, M, T>

pub fn set(&mut self, index: usize, item: &T) -> Result<(), InvalidSliceError>

pub fn slice(&self, start_index: usize, end_index: usize) -> Option<Self>

Returns a new ManagedVec, containing the [start_index, end_index) range of elements. Returns None if any index is out of range

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

pub fn remove(&mut self, index: usize)

pub fn from_single_item(item: T) -> Self

New ManagedVec instance with 1 element in it.

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

pub fn append_vec(&mut self, item: ManagedVec<M, T>)

Appends all the contents of another managed vec at the end of the current one. Consumes the other vec in the process.

pub fn clear(&mut self)

Removes all items while retaining the handle.

pub fn iter(&self) -> ManagedVecRefIterator<'_, M, T>

pub fn as_multi(&self) -> &MultiValueManagedVec<M, T>

Creates a reference to and identical object, but one which behaves like a multi-value-vec.

impl<M, T> ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + Ord + Debug,

pub fn sort(&mut self)

pub fn sort_by<F>(&mut self, compare: F)where F: FnMut(&T, &T) -> Ordering,

pub fn sort_by_key<K, F>(&mut self, f: F)where F: FnMut(&T) -> K, K: Ord,

pub fn sort_by_cached_key<K, F>(&mut self, f: F)where F: FnMut(&T) -> K, K: Ord,

pub fn sort_unstable(&mut self)

pub fn sort_unstable_by<F>(&mut self, compare: F)where F: FnMut(&T, &T) -> Ordering,

pub fn sort_unstable_by_key<K, F>(&mut self, f: F)where F: FnMut(&T) -> K, K: Ord,

pub fn is_sorted(&self) -> bool

pub fn is_sorted_by<F>(&self, compare: F) -> boolwhere F: FnMut(&T, &T) -> Option<Ordering>,

pub fn is_sorted_by_key<K, F>(&self, f: F) -> boolwhere F: FnMut(&T) -> K, K: Ord,

impl<M, T> ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + PartialEq + Debug,

pub fn dedup(&mut self)

impl<M, T> ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + PartialEq,

pub fn find(&self, item: &T) -> Option<usize>

This can be very costly for big collections. It needs to deserialize and compare every single item in the worst case.

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

This can be very costly for big collections. It needs to iterate, deserialize, and compare every single item in the worst case.

Trait Implementations

impl<M, T> Clone for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, T> Debug for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + Debug + Clone,

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

Formats the value using the given formatter.

impl<M, T> Default for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

fn default() -> Self

Returns the “default value” for a type.

impl<M, V> Extend<V> for ManagedVec<M, V>where M: ManagedTypeApi, V: ManagedVecItem,

fn extend<T: IntoIterator<Item = V>>(&mut self, iter: 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<M, T> From<&ManagedVec<M, T>> for MultiValueEncoded<M, T>where M: ManagedTypeApi, T: ManagedVecItem + TopEncode,

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

Converts to this type from the input type.

impl<M> From<ManagedVec<M, ManagedBuffer<M>>> for ManagedArgBuffer<M>where M: ManagedTypeApi,

fn from(data: ManagedVec<M, ManagedBuffer<M>>) -> Self

Converts to this type from the input 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>) -> Self

Converts to this type from the input type.

impl<M, T> From<ManagedVec<M, T>> for MultiValueManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

fn from(managed_vec: ManagedVec<M, T>) -> Self

Converts to this type from the input type.

impl<M, T> From<ManagedVec<M, T>> for MultiValueManagedVecCounted<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

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

Converts to this type from the input type.

impl<M, T, I> From<Vec<I, Global>> for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem, I: Into<T>,

fn from(v: Vec<I>) -> Self

Converts to this type from the input type.

impl<M, V> FromIterator<V> for ManagedVec<M, V>where M: ManagedTypeApi, V: ManagedVecItem,

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

Creates a value from an iterator.

impl<'a, M, T> IntoIterator for &'a ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

type Item = T

The type of the elements being iterated over.

type IntoIter = ManagedVecOwnedIterator<'a, 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> IntoMultiValue for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + IntoMultiValue,

type MultiValue = MultiValueEncoded<M, <T as IntoMultiValue>::MultiValue>

fn into_multi_value(self) -> Self::MultiValue

impl<M, T> ManagedType<M> for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

fn get_handle(&self) -> M::ManagedBufferHandle

fn transmute_from_handle_ref(handle_ref: &M::ManagedBufferHandle) -> &Self

Implement carefully, since the underlying transmutation is an unsafe operation. For types that wrap a handle to some VM-managed data, make sure the type only contains the handle (plus ZSTs if necessary). For types that just wrap another managed type it is easier, call for the wrapped object.

fn get_raw_handle(&self) -> RawHandle

fn as_ref(&self) -> ManagedRef<'_, M, Self>

impl<M, T> ManagedVecItem for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem,

const PAYLOAD_SIZE: usize = 4usize

Size of the data stored in the underlying ManagedBuffer.

const SKIPS_RESERIALIZATION: bool = false

If true, then the encoding of the item is identical to the payload, and no further conversion is necessary (the underlying buffer can be used as-is during serialization). False for all managed types, but true for basic types (like u32).

type Ref<'a> = ManagedRef<'a, M, ManagedVec<M, T>>

Reference representation of the ManagedVec item.

fn from_byte_reader<Reader: FnMut(&mut [u8])>(reader: Reader) -> Self

Parses given bytes as a an owned object.

unsafe fn from_byte_reader_as_borrow<'a, Reader: FnMut(&mut [u8])>( reader: Reader ) -> Self::Ref<'a>

Parses given bytes as a representation of the object, either owned, or a reference.

fn to_byte_writer<R, Writer: FnMut(&[u8]) -> R>(&self, writer: Writer) -> R

impl<M, T> NestedDecode for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + NestedDecode,

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H ) -> Result<Self, H::HandledErr>where I: NestedDecodeInput, H: DecodeErrorHandler,

Version of dep_decode 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 dep_decode<I>(input: &mut I) -> Result<Self, DecodeError>where I: NestedDecodeInput,

Attempt to deserialise the value from input, using the format of an object nested inside another structure. In case of success returns the deserialized value and the number of bytes consumed during the operation.

impl<M, T> NestedEncode for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + NestedEncode,

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H ) -> Result<(), H::HandledErr>where O: NestedEncodeOutput, H: EncodeErrorHandler,

Version of dep_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 dep_encode<O>(&self, dest: &mut O) -> Result<(), EncodeError>where O: NestedEncodeOutput,

NestedEncode to output, using the format of an object nested inside another structure. Does not provide compact version.

impl<M, T> PartialEq<ManagedVec<M, T>> for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + PartialEq,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M, T> TopDecode for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + NestedDecode,

fn top_decode_or_handle_err<I, H>(input: I, h: H) -> Result<Self, H::HandledErr>where I: TopDecodeInput, H: DecodeErrorHandler,

Version of top_decode that can handle errors as soon as they occur. For instance it 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 top_decode<I>(input: I) -> Result<Self, DecodeError>where I: TopDecodeInput,

Attempt to deserialize the value from input.

impl<M, T> TopEncode for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + NestedEncode,

fn top_encode_or_handle_err<O, H>( &self, output: O, h: H ) -> Result<(), H::HandledErr>where O: TopEncodeOutput, 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 top_encode<O>(&self, output: O) -> Result<(), EncodeError>where O: TopEncodeOutput,

Attempt to serialize the value to ouput.

impl<M> TopEncodeMultiOutput for ManagedVec<M, ManagedBuffer<M>>where M: ManagedTypeApi,

fn push_single_value<T, H>( &mut self, arg: &T, h: H ) -> Result<(), H::HandledErr>where T: TopEncode, H: EncodeErrorHandler,

fn push_multi_specialized<T, H>( &mut self, _arg: &T, h: H ) -> Result<(), <H as EncodeErrorHandler>::HandledErr>where T: TryStaticCast, H: EncodeErrorHandler,

This is temporary, will remove after we get rid of SCResult for good.

impl<M, T> TypeAbi for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + TypeAbi,

fn type_name() -> TypeName

It is semantically equivalent to any list of T.

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

A type can provide more than its own description. 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.

impl<M, T> Eq for ManagedVec<M, T>where M: ManagedTypeApi, T: ManagedVecItem + PartialEq,