Struct Metadata

pub struct Metadata { /* private fields */ }

An asset denomination’s metadata.

Each denomination has a unique Id and base unit, and may also have other display units.

Implementations

impl Metadata

pub fn id(&self) -> Id

Return the Id associated with this denomination.

pub fn base_denom(&self) -> Denom

pub fn symbol(&self) -> &str

pub fn value(&self, amount: Amount) -> Value

Create a value of this denomination.

pub fn units(&self) -> Vec<Unit>

Return a list of display units for this denomination, in size order.

There will always be at least one display denomination.

pub fn default_unit(&self) -> Unit

Returns the default (largest) unit for this denomination.

pub fn base_unit(&self) -> Unit

Returns the base (smallest) unit for this denomination.

(This treats the base denomination as a display unit).

pub fn best_unit_for(&self, amount: Amount) -> Unit

Returns the “best” unit for the given amount (expressed in units of the base denomination).

This is defined as the largest unit smaller than the given value (so it has no leading zeros when formatted).

pub fn starts_with(&self, prefix: &str) -> bool

pub fn default_for(denom: &Denom) -> Option<Metadata>

pub fn is_auction_nft(&self) -> bool

pub fn is_withdrawn_auction_nft(&self) -> bool

pub fn is_opened_position_nft(&self) -> bool

pub fn is_withdrawn_position_nft(&self) -> bool

pub fn is_closed_position_nft(&self) -> bool

pub fn best_effort_ibc_transfer_parse(&self) -> Option<(String, String)>

Returns the IBC transfer path and base denom if this is an IBC transferred asset, None otherwise.

This MUST NOT be used on safety critical paths. The reason is that this function has not received a great deal of testing and is meant for low stakes RPC usecases. Hence: best_effort_ibc_transfer_parse.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Metadata

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

Formats the value using the given formatter.

impl DomainType for Metadata

type Proto = Metadata

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl Extend<Metadata> for Cache

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

where T: IntoIterator<Item = Metadata>,

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 From<Metadata> for Id

fn from(base: Metadata) -> Id

Converts to this type from the input type.

impl From<Metadata> for Metadata

fn from(dn: Metadata) -> Self

Converts to this type from the input type.

impl FromIterator<Metadata> for Cache

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

Creates a value from an iterator.

impl Hash for Metadata

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Metadata

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Metadata

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 PartialOrd for Metadata

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Metadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Metadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<AssetsResponse> for Metadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(response: AssetsResponse) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Metadata> for Metadata

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Metadata) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Metadata