Struct TokenIdentifier

pub struct TokenIdentifier<M>
where
    M: ErrorApi + ManagedTypeApi,
{ /* private fields */ }

Specialized type for handling token identifiers. It wraps a BoxedBytes with the full ASCII name of the token. EGLD is stored as an empty name.

Not yet implemented, but we might add additional restrictions when deserializing as argument.

Implementations

impl<M> TokenIdentifier<M>

where M: ManagedTypeApi,

pub unsafe fn esdt_unchecked( data: EgldOrEsdtTokenIdentifier<M>, ) -> TokenIdentifier<M>

Creates a new TokenIdentifier without verifying that it is not EGLD-000000.

Safety

Calling it for the EGLD token might lead to unexpected bugs.

pub fn try_new(data: EgldOrEsdtTokenIdentifier<M>) -> Option<TokenIdentifier<M>>

pub fn from_esdt_bytes<B>(bytes: B) -> TokenIdentifier<M>

where B: Into<ManagedBuffer<M>>,

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

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

pub fn to_boxed_bytes(&self) -> BoxedBytes

pub fn is_valid_esdt_identifier(&self) -> bool

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

Trait Implementations

impl<Env> AnnotatedValue<Env, TokenIdentifier<<Env as TxEnv>::Api>> for &TokenIdentifier<<Env as TxEnv>::Api>

where Env: TxEnv,

fn annotation(&self, _env: &Env) -> ManagedBuffer<<Env as TxEnv>::Api>

fn to_value(&self, _env: &Env) -> TokenIdentifier<<Env as TxEnv>::Api>

Produces the value from a reference of the annotated type. Might involve a .clone() in some cases.

fn into_value(self, _env: &Env) -> TokenIdentifier<<Env as TxEnv>::Api>

Consumes annotated value to produce actual value.

fn with_value_ref<F, R>(&self, _env: &Env, f: F) -> R

where F: FnOnce(&TokenIdentifier<<Env as TxEnv>::Api>) -> R,

Can be used when working with references only.

impl<Env> AnnotatedValue<Env, TokenIdentifier<<Env as TxEnv>::Api>> for TestTokenIdentifier<'_>

where Env: TxEnv,

fn annotation(&self, _env: &Env) -> ManagedBuffer<<Env as TxEnv>::Api>

fn to_value(&self, _env: &Env) -> TokenIdentifier<<Env as TxEnv>::Api>

Produces the value from a reference of the annotated type. Might involve a .clone() in some cases.

fn into_value(self, env: &Env) -> T

Consumes annotated value to produce actual value.

fn with_value_ref<F, R>(&self, env: &Env, f: F) -> R

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

Can be used when working with references only.

impl<Env> AnnotatedValue<Env, TokenIdentifier<<Env as TxEnv>::Api>> for TokenIdentifier<<Env as TxEnv>::Api>

where Env: TxEnv,

fn annotation(&self, env: &Env) -> ManagedBuffer<<Env as TxEnv>::Api>

fn to_value(&self, _env: &Env) -> TokenIdentifier<<Env as TxEnv>::Api>

Produces the value from a reference of the annotated type. Might involve a .clone() in some cases.

fn into_value(self, _env: &Env) -> TokenIdentifier<<Env as TxEnv>::Api>

Consumes annotated value to produce actual value.

fn with_value_ref<F, R>(&self, _env: &Env, f: F) -> R

where F: FnOnce(&TokenIdentifier<<Env as TxEnv>::Api>) -> R,

Can be used when working with references only.

impl<M> Clone for TokenIdentifier<M>

where M: Clone + ErrorApi + ManagedTypeApi,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Formats the value using the given formatter.

impl<M> Display for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Formats the value using the given formatter.

impl<M> From<&[u8]> for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

impl<M> From<&String> for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

impl<M> From<&str> for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

impl<M> From<ManagedBuffer<M>> for TokenIdentifier<M>

where M: ManagedTypeApi,

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

Converts to this type from the input type.

impl<'a, Api> From<TestTokenIdentifier<'a>> for TokenIdentifier<Api>

where Api: ManagedTypeApi,

fn from(value: TestTokenIdentifier<'a>) -> TokenIdentifier<Api>

Converts to this type from the input type.

impl<M> ManagedType<M> for TokenIdentifier<M>

where M: ManagedTypeApi,

type OwnHandle = <M as HandleTypeInfo>::ManagedBufferHandle

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

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

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

fn transmute_from_handle_ref( handle_ref: &<M as HandleTypeInfo>::ManagedBufferHandle, ) -> &TokenIdentifier<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 TokenIdentifier<M>

fn get_raw_handle(&self) -> i32

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

impl<M> ManagedVecItem for TokenIdentifier<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<4>

Type managing the underlying binary representation in a ManagedVec..

type Ref<'a> = ManagedRef<'a, M, TokenIdentifier<M>>

Reference representation of the ManagedVec item.

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

Parses given bytes as a an owned object.

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

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

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

Converts the object into bytes.

fn payload_size() -> usize

impl<M> NestedDecode for TokenIdentifier<M>

where M: ManagedTypeApi,

fn dep_decode_or_handle_err<I, H>( input: &mut I, h: H, ) -> Result<TokenIdentifier<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 TokenIdentifier<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<EgldOrEsdtTokenIdentifier<M>> for TokenIdentifier<M>

where M: ManagedTypeApi,

fn eq(&self, other: &EgldOrEsdtTokenIdentifier<M>) -> 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> PartialEq<TokenIdentifier<M>> for EgldOrEsdtTokenIdentifier<M>

where M: ManagedTypeApi,

fn eq(&self, other: &TokenIdentifier<M>) -> 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> PartialEq for TokenIdentifier<M>

where M: ManagedTypeApi,

fn eq(&self, other: &TokenIdentifier<M>) -> 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> SCDisplay for TokenIdentifier<M>

where M: ManagedTypeApi,

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

where F: FormatByteReceiver,

impl<M> SCLowerHex for TokenIdentifier<M>

where M: ManagedTypeApi,

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

where F: FormatByteReceiver,

impl<M> TopDecode for TokenIdentifier<M>

where M: ManagedTypeApi,

fn top_decode_or_handle_err<I, H>( input: I, h: H, ) -> Result<TokenIdentifier<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 TokenIdentifier<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 ouput.

impl<M> TypeAbi for TokenIdentifier<M>

where M: ManagedTypeApi,

type Unmanaged = TokenIdentifier<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 TokenIdentifier<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&[u8]> for TokenIdentifier<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&TokenIdentifier<M>> for EgldOrEsdtTokenIdentifier<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<&TokenIdentifier<M>> for TokenIdentifier<M>

where M: ManagedTypeApi,

impl<SA> TypeAbiFrom<FungibleTokenMapper<SA>> for TokenIdentifier<SA>

where SA: StorageMapperApi + CallTypeApi,

impl<SA> TypeAbiFrom<NonFungibleTokenMapper<SA>> for TokenIdentifier<SA>

where SA: StorageMapperApi + CallTypeApi,

impl<Api> TypeAbiFrom<TestTokenIdentifier<'_>> for TokenIdentifier<Api>

where Api: ManagedTypeApi,

impl<M> TypeAbiFrom<TokenIdentifier<M>> for EgldOrEsdtTokenIdentifier<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<TokenIdentifier<M>> for TokenIdentifier<M>

where M: ManagedTypeApi,

impl<M> TypeAbiFrom<Vec<u8>> for TokenIdentifier<M>

where M: ManagedTypeApi,