TokenId

multiversx_sc_snippets::imports

Struct TokenId

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

Expand description

Specialized type for handling token identifiers (e.g. ABCDEF-123456).

Implementations§

impl<M> TokenId<M>
where M: ManagedTypeApi,

pub fn new(data: ManagedBuffer<M>) -> TokenId<M>

pub fn new_backwards_compatible(data: ManagedBuffer<M>) -> TokenId<M>

pub fn into_managed_buffer(self) -> ManagedBuffer<M>

pub fn as_managed_buffer(&self) -> &ManagedBuffer<M>

pub fn into_legacy(self) -> EgldOrEsdtTokenIdentifier<M>

pub fn as_legacy(&self) -> &EgldOrEsdtTokenIdentifier<M>

pub unsafe fn as_esdt_unchecked(&self) -> &EsdtTokenIdentifier<M>

Converts to a specialized ESDT token identifier.

§Safety

Leads to inconsistencies if the token is EGLD.

pub unsafe fn into_esdt_unchecked(self) -> EsdtTokenIdentifier<M>

Converts to a specialized ESDT token identifier.

§Safety

Leads to inconsistencies if the token is EGLD.

pub fn to_boxed_bytes(&self) -> BoxedBytes

pub fn is_native(&self) -> bool

Checks if a token is the native one on the chain. Currently only returns true for EGLD-000000.

pub fn is_valid(&self) -> bool

Checks the ESDT token identifier for validity.

Will fail if it encodes an invalid ESDT token identifier.

pub fn is_valid_esdt_identifier(&self) -> bool

Old method name. Kept for easier transition. Use is_valid instead.

pub fn ticker(&self) -> ManagedBuffer<M>

Extracts the ticker from the token identifier.

E.g. for “ABCDEF-123456” it will return “ABCDEF”.

Trait Implementations§

impl<M> AsRef<TokenId<M>> for EgldOrEsdtTokenIdentifier<M>
where M: ManagedTypeApi,

fn as_ref(&self) -> &TokenId<M>

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

impl<M> AsRef<TokenId<M>> for TokenId<M>
where M: ManagedTypeApi,

fn as_ref(&self) -> &TokenId<M>

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

impl<M> Clone for TokenId<M>
where M: Clone + ManagedTypeApi,

fn clone(&self) -> TokenId<M>

Returns a duplicate of the value. Read more

1.0.0§

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

Performs copy-assignment from source. Read more

impl<M> Debug for TokenId<M>
where M: ManagedTypeApi,

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

Formats the value using the given formatter. Read more

impl<M> Display for TokenId<M>
where M: ManagedTypeApi,

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

Formats the value using the given formatter. Read more

impl<M> From<&[u8]> for TokenId<M>
where M: ManagedTypeApi,

fn from(bytes: &[u8]) -> TokenId<M>

Converts to this type from the input type.

impl<M, const N: usize> From<&[u8; N]> for TokenId<M>
where M: ManagedTypeApi,

fn from(bytes: &[u8; N]) -> TokenId<M>

Converts to this type from the input type.

impl<M> From<&String> for TokenId<M>
where M: ManagedTypeApi,

fn from(s: &String) -> TokenId<M>

Converts to this type from the input type.

impl<M> From<&str> for TokenId<M>
where M: ManagedTypeApi,

fn from(s: &str) -> TokenId<M>

Converts to this type from the input type.

impl<M> From<EgldOrEsdtTokenIdentifier<M>> for TokenId<M>
where M: ManagedTypeApi,

fn from(token_id: EgldOrEsdtTokenIdentifier<M>) -> TokenId<M>

Converts to this type from the input type.

impl<M> From<ManagedBuffer<M>> for TokenId<M>
where M: ManagedTypeApi,

fn from(buffer: ManagedBuffer<M>) -> TokenId<M>

Converts to this type from the input type.

impl<M> From<TokenId<M>> for EgldOrEsdtTokenIdentifier<M>
where M: ManagedTypeApi,

fn from(token_id: TokenId<M>) -> EgldOrEsdtTokenIdentifier<M>

Converts to this type from the input type.

impl<M> From<TokenId<M>> for EsdtTokenIdentifier<M>
where M: ManagedTypeApi,

fn from(token_id: TokenId<M>) -> EsdtTokenIdentifier<M>

Converts to this type from the input type.

impl<M> ManagedType<M> for TokenId<M>
where M: ManagedTypeApi,

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

fn get_handle(&self) -> <M as HandleTypeInfo>::ManagedBufferHandle

unsafe fn forget_into_handle(self) -> <TokenId<M> as ManagedType<M>>::OwnHandle

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

fn transmute_from_handle_ref( handle_ref: &<M as HandleTypeInfo>::ManagedBufferHandle, ) -> &TokenId<M>

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 as HandleTypeInfo>::ManagedBufferHandle, ) -> &mut TokenId<M>

fn get_raw_handle(&self) -> i32

fn get_raw_handle_unchecked(&self) -> i32

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

impl<M> ManagedVecItem for TokenId<M>
where M: ManagedTypeApi,

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, TokenId<M>>

Reference representation of the ManagedVec item. Read more

fn read_from_payload( payload: &<TokenId<M> as ManagedVecItem>::PAYLOAD, ) -> TokenId<M>

Parses given bytes as a an owned object.

unsafe fn borrow_from_payload<'a>( payload: &<TokenId<M> as ManagedVecItem>::PAYLOAD, ) -> <TokenId<M> as ManagedVecItem>::Ref<'a>

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

fn save_to_payload(self, payload: &mut <TokenId<M> as ManagedVecItem>::PAYLOAD)

Converts the object into bytes. Read more

fn payload_size() -> usize

impl<M> NestedDecode for TokenId<M>
where M: ManagedTypeApi,

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<TokenId<M>, <H as DecodeErrorHandler>::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> NestedEncode for TokenId<M>
where M: ManagedTypeApi,

fn dep_encode_or_handle_err<O, H>( &self, dest: &mut O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::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> PartialEq for TokenId<M>
where M: ManagedTypeApi,

fn eq(&self, other: &TokenId<M>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0§

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> SCDisplay for TokenId<M>
where M: ManagedTypeApi,

fn fmt<F>(&self, f: &mut F)
where F: FormatByteReceiver,

impl<M> SCLowerHex for TokenId<M>
where M: ManagedTypeApi,

fn fmt<F>(&self, f: &mut F)
where F: FormatByteReceiver,

impl<M> TopDecode for TokenId<M>
where M: ManagedTypeApi,

fn top_decode_or_handle_err<I, H>( input: I, h: H, ) -> Result<TokenId<M>, <H as DecodeErrorHandler>::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> TopEncode for TokenId<M>
where M: ManagedTypeApi,

fn top_encode_or_handle_err<O, H>( &self, output: O, h: H, ) -> Result<(), <H as EncodeErrorHandler>::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> TypeAbi for TokenId<M>
where M: ManagedTypeApi,

type Unmanaged = TokenId<M>

fn type_name() -> String

fn type_name_rust() -> String

fn type_names() -> TypeNames

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.

impl<M> Eq for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&[u8]> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&EsdtTokenIdentifier<M>> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&TestTokenIdentifier<'_>> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&TokenId<M>> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&str> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<EsdtTokenIdentifier<M>> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<TestTokenIdentifier<'_>> for TokenId<M>
where M: ManagedTypeApi,

impl<M> TypeAbiFrom<TokenId<M>> for TokenId<M>
where M: ManagedTypeApi,

Auto Trait Implementations§

impl<M> Freeze for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: Freeze,

impl<M> RefUnwindSafe for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: RefUnwindSafe,

impl<M> Send for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: Send,

impl<M> Sync for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: Sync,

impl<M> Unpin for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: Unpin,

impl<M> UnwindSafe for TokenId<M>
where <M as HandleTypeInfo>::ManagedBufferHandle: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> InterpretableFrom<&T> for T
where T: Clone,

fn interpret_from(from: &T, _context: &InterpreterContext) -> T

impl<T> InterpretableFrom<T> for T

fn interpret_from(from: T, _context: &InterpreterContext) -> T

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> MultiValueConstLength for T
where T: TopEncode + TopDecode,

const MULTI_VALUE_CONST_LEN: usize = 1usize

The fixed (constant) number of single items contained a multi-value. Read more

impl<T> MultiValueLength for T
where T: TopEncode + TopDecode,

fn multi_value_len(&self) -> usize

The number of single items contained a multi-value.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ReconstructableFrom<&T> for T
where T: Clone,

fn reconstruct_from(from: &T, _builder: &ReconstructorContext) -> T

impl<T> ReconstructableFrom<T> for T

fn reconstruct_from(from: T, _builder: &ReconstructorContext) -> T

impl<T> SCCodec for T
where T: TopEncode,

fn fmt<F>(&self, f: &mut F)
where F: FormatByteReceiver,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

impl<T> TopDecodeMulti for T
where T: TopDecode,

const IS_SINGLE_VALUE: bool = true

Used to optimize single value loading of endpoint arguments.

fn multi_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<T, <H as DecodeErrorHandler>::HandledErr>
where I: TopDecodeMultiInput, H: DecodeErrorHandler,

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

impl<T> TopEncodeMulti for T
where T: TopEncode,

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 output.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<O, T> ProxyArg<O> for T
where O: TypeAbiFrom<T>, T: TopEncodeMulti,