Struct ManagedVec 

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

Creates a new, empty ManagedVec.

pub unsafe fn new_uninit() -> Self

Creates a new object, without initializing it.

Safety

The value needs to be initialized after creation, otherwise the VM will halt the first time the value is attempted to be read.

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

Returns true if the vec contains no elements.

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

Retrieves the element at index, or None if the index is out of range.

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 is_single_item(&self) -> Option<T::Ref<'_>>

If it contains precisely one item, will return Some with a reference to that item.

Will return None for zero or more than one item.

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

Returns a mutable guard for the element at index, allowing in-place modification.

Signals an error and terminates execution if the index is out of range.

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

Replaces the element at index with item, returning the displaced element.

Signals an error and terminates execution if the index is out of range.

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

where T: Clone,

Returns a new ManagedVec containing the elements in the half-open range [start_index, end_index). Returns None if the range is invalid (start_index > end_index or end_index > self.len()).

Cloning strategy

The implementation chooses between two paths based on whether T owns VM-level resources (i.e. T::requires_drop()):

• Copy-like types (T::requires_drop() == false, e.g. u32, u64, fixed-size structs of plain integers): the relevant slice of the underlying managed buffer is copied in a single VM call. No per-item work is done.

• Handle-owning types (T::requires_drop() == true, e.g. BigUint, ManagedBuffer, or any struct containing them): copying raw bytes would alias the integer handles stored in the payload, causing both the original vec and the returned vec to attempt freeing the same VM object on drop (double-free). Instead each item in the range is cloned individually, allocating a fresh independent VM object for every element.

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

where T: Clone,

👎Deprecated since 0.66.2:

Please use method clone_range instead.

Deprecated alias for [clone_range].

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

Appends item to the back of the vec.

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

Removes and returns the element at index, shifting the remaining elements.

Signals an error and terminates execution if the index is out of range.

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

Removes and drops the element at index, shifting the remaining elements.

Signals an error and terminates execution if the index is out of range.

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)

Replaces all contents of the vec with a single item, dropping all previous elements.

pub fn append_vec(&mut self, v: 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 into_vec(self) -> Vec<T>

Converts the ManagedVec into a standard Vec<T>, consuming the vec in the process.

pub fn with_self_as_vec<R, F>(&mut self, f: F) -> R

where F: FnOnce(&mut Vec<T>) -> R,

Temporarily converts self to a Vec<T>. All operations performed on the temporary vector get saved back to the underlying buffer.

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

Returns an iterator over shared references to the elements of the vec.

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

Creates a reference to an 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)

👎Deprecated since 0.54.5:

Please use method sort_unstable instead.

pub fn sort_by<F>(&mut self, compare: F)

where F: FnMut(&T, &T) -> Ordering,

👎Deprecated since 0.54.5:

Please use method sort_unstable_by instead.

pub fn sort_by_key<K, F>(&mut self, f: F)

where F: FnMut(&T) -> K, K: Ord,

👎Deprecated since 0.54.5:

Please use method sort_unstable_by_key instead.

pub fn sort_by_cached_key<K, F>(&mut self, f: F)

where F: FnMut(&T) -> K, K: Ord,

👎Deprecated

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

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.

impl<M: ManagedTypeApi> ManagedVec<M, EsdtTokenPayment<M>>

pub fn as_multi_egld_or_esdt_payment(&self) -> &MultiEgldOrEsdtPayment<M>

Zero-cost conversion that loosens the EGLD restriction.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

pub fn into_multi_egld_or_esdt_payment(self) -> MultiEgldOrEsdtPayment<M>

Zero-cost conversion that loosens the EGLD restriction.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

pub fn into_payment_vec(self) -> PaymentVec<M>

Zero-cost conversion that loosens the EGLD restriction.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

impl<M> ManagedVec<M, EgldOrEsdtTokenPayment<M>>

where M: ManagedTypeApi,

pub fn egld_sum(&self) -> BigUint<M>

The sum of all EGLD-000000 transfers.

pub fn to_single_esdt(self) -> EsdtTokenPayment<M>

Requires that this is a single ESDT payment, and returns it, crashes otherwise.

pub fn into_multi_value( self, ) -> MultiValueEncoded<M, EgldOrEsdtTokenPaymentMultiValue<M>>

Converts to a multi-value object, in this case a multi-value list of triples: [(token identifier, payment, nonce)]

pub fn into_payment_vec(self) -> PaymentVec<M>

Converts to the newer PaymentVec (ManagedVec).

impl<M: ManagedTypeApi> ManagedVec<M, Payment<M>>

pub fn as_multi_egld_or_esdt_payment(&self) -> &MultiEgldOrEsdtPayment<M>

Converts to the legacy MultiEgldOrEsdtPayment.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

pub fn into_multi_egld_or_esdt_payment(self) -> MultiEgldOrEsdtPayment<M>

Converts to the legacy MultiEgldOrEsdtPayment.

It is always safe to do, since the 2 types are guaranteed to have the same layout.

Trait Implementations

impl<M, T> AsRef<ManagedVec<M, T>> for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem,

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

Converts this type into a shared reference of the (usually inferred) input type.

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

where M: ManagedTypeApi, T: ManagedVecItem + Clone,

fn clone(&self) -> Self

Returns a duplicate 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, T> Drop for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<M, T> Eq for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem + PartialEq,

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<A> From<ManagedVec<A, EgldOrEsdtTokenPayment<A>>> for BackTransfers<A>

where A: ManagedTypeApi,

fn from(value: MultiEgldOrEsdtPayment<A>) -> 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>> 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, T, I, const N: usize> From<[I; N]> for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem, I: Into<T>,

fn from(arr: [I; N]) -> 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<M, T> IntoIterator for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem,

type Item = T

The type of the elements being iterated over.

type IntoIter = ManagedVecOwnedIterator<M, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, M, T> IntoIterator for &'a ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem,

type Item = <T as ManagedVecItem>::Ref<'a>

The type of the elements being iterated over.

type IntoIter = ManagedVecRefIterator<'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

unsafe fn forget_into_handle(self) -> Self::OwnHandle

Forgets current object (does not run destructor), but extracts the handle.

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 transmute_from_handle_ref_mut( handle_ref: &mut M::ManagedBufferHandle, ) -> &mut Self

fn get_raw_handle(&self) -> RawHandle

fn get_raw_handle_unchecked(&self) -> RawHandle

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

impl<M, T> ManagedVecItem for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem,

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 PAYLOAD = ManagedVecItemPayloadBuffer<UInt<UInt<UInt<UTerm, B1>, B0>, B0>>

Type managing the underlying binary representation in a ManagedVec..

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

Reference representation of the ManagedVec item.

unsafe fn read_from_payload(payload: &Self::PAYLOAD) -> Self

Parses given bytes as a an owned object.

unsafe fn borrow_from_payload<'a>(payload: &Self::PAYLOAD) -> Self::Ref<'a>

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

fn save_to_payload(self, payload: &mut Self::PAYLOAD)

Converts the object into bytes.

fn requires_drop() -> bool

Signals that vec should drop all items one by one when being itself dropped.

fn payload_size() -> usize

fn temp_decode<F, R>(payload: &Self::PAYLOAD, f: F) -> R

where F: FnOnce(&Self) -> 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 for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem + PartialEq,

fn eq(&self, other: &Self) -> 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> 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 output.

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.

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

fn type_name_rust() -> TypeName

The type name as it shows up in Rust code. Used for proxies.

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

fn type_name_specific() -> Option<TypeName>

Specific name to be optionally added to the ABI.

impl<M, T, U> TypeAbiFrom<ManagedVec<M, U>> for ManagedVec<M, T>

where M: ManagedTypeApi, U: ManagedVecItem, T: ManagedVecItem + TypeAbiFrom<U>,

impl<M, T, U> TypeAbiFrom<ManagedVec<M, U>> for Vec<T>

where M: ManagedTypeApi, U: ManagedVecItem, T: TypeAbiFrom<U>,

impl<M, T, U> TypeAbiFrom<Vec<U>> for ManagedVec<M, T>

where M: ManagedTypeApi, T: ManagedVecItem + TypeAbiFrom<U>,