Struct CoinMetadata

#[non_exhaustive]
pub struct CoinMetadata {
    pub id: Option<String>,
    pub decimals: Option<u32>,
    pub name: Option<String>,
    pub symbol: Option<String>,
    pub description: Option<String>,
    pub icon_url: Option<String>,
    pub metadata_cap_id: Option<String>,
    pub metadata_cap_state: Option<i32>,
}

Metadata for a coin type

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

ObjectId of the 0x2::coin::CoinMetadata object or 0x2::sui::coin_registry::Currency object (when registered with CoinRegistry).

decimals: Option<u32>

Number of decimal places to coin uses.

name: Option<String>

Name for the token

symbol: Option<String>

Symbol for the token

description: Option<String>

Description of the token

icon_url: Option<String>

URL for the token logo

metadata_cap_id: Option<String>

The MetadataCap ID if it has been claimed for this coin type. This capability allows updating the coin’s metadata fields. Only populated when metadata is from CoinRegistry.

metadata_cap_state: Option<i32>

State of the MetadataCap for this coin type.

Implementations

impl CoinMetadata

pub const ID_FIELD: &'static MessageField

pub const DECIMALS_FIELD: &'static MessageField

pub const NAME_FIELD: &'static MessageField

pub const SYMBOL_FIELD: &'static MessageField

pub const DESCRIPTION_FIELD: &'static MessageField

pub const ICON_URL_FIELD: &'static MessageField

pub const METADATA_CAP_ID_FIELD: &'static MessageField

pub const METADATA_CAP_STATE_FIELD: &'static MessageField

impl CoinMetadata

pub fn path_builder() -> CoinMetadataFieldPathBuilder

impl CoinMetadata

pub const fn const_default() -> Self

pub fn id_opt_mut(&mut self) -> Option<&mut String>

If id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn id_mut(&mut self) -> &mut String

Returns a mutable reference to id. If the field is unset, it is first initialized with the default value.

pub fn id_opt(&self) -> Option<&str>

If id is set, returns Some with the value; otherwise returns None.

pub fn set_id<T: Into<String>>(&mut self, field: T)

Sets id with the provided value.

pub fn with_id<T: Into<String>>(self, field: T) -> Self

Sets id with the provided value.

pub fn decimals_opt_mut(&mut self) -> Option<&mut u32>

If decimals is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn decimals_mut(&mut self) -> &mut u32

Returns a mutable reference to decimals. If the field is unset, it is first initialized with the default value.

pub fn decimals_opt(&self) -> Option<u32>

If decimals is set, returns Some with the value; otherwise returns None.

pub fn set_decimals<T: Into<u32>>(&mut self, field: T)

Sets decimals with the provided value.

pub fn with_decimals<T: Into<u32>>(self, field: T) -> Self

Sets decimals with the provided value.

pub fn name_opt_mut(&mut self) -> Option<&mut String>

If name is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn name_mut(&mut self) -> &mut String

Returns a mutable reference to name. If the field is unset, it is first initialized with the default value.

pub fn name_opt(&self) -> Option<&str>

If name is set, returns Some with the value; otherwise returns None.

pub fn set_name<T: Into<String>>(&mut self, field: T)

Sets name with the provided value.

pub fn with_name<T: Into<String>>(self, field: T) -> Self

Sets name with the provided value.

pub fn symbol_opt_mut(&mut self) -> Option<&mut String>

If symbol is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn symbol_mut(&mut self) -> &mut String

Returns a mutable reference to symbol. If the field is unset, it is first initialized with the default value.

pub fn symbol_opt(&self) -> Option<&str>

If symbol is set, returns Some with the value; otherwise returns None.

pub fn set_symbol<T: Into<String>>(&mut self, field: T)

Sets symbol with the provided value.

pub fn with_symbol<T: Into<String>>(self, field: T) -> Self

Sets symbol with the provided value.

pub fn description_opt_mut(&mut self) -> Option<&mut String>

If description is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn description_mut(&mut self) -> &mut String

Returns a mutable reference to description. If the field is unset, it is first initialized with the default value.

pub fn description_opt(&self) -> Option<&str>

If description is set, returns Some with the value; otherwise returns None.

pub fn set_description<T: Into<String>>(&mut self, field: T)

Sets description with the provided value.

pub fn with_description<T: Into<String>>(self, field: T) -> Self

Sets description with the provided value.

pub fn icon_url_opt_mut(&mut self) -> Option<&mut String>

If icon_url is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn icon_url_mut(&mut self) -> &mut String

Returns a mutable reference to icon_url. If the field is unset, it is first initialized with the default value.

pub fn icon_url_opt(&self) -> Option<&str>

If icon_url is set, returns Some with the value; otherwise returns None.

pub fn set_icon_url<T: Into<String>>(&mut self, field: T)

Sets icon_url with the provided value.

pub fn with_icon_url<T: Into<String>>(self, field: T) -> Self

Sets icon_url with the provided value.

pub fn metadata_cap_id_opt_mut(&mut self) -> Option<&mut String>

If metadata_cap_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn metadata_cap_id_mut(&mut self) -> &mut String

Returns a mutable reference to metadata_cap_id. If the field is unset, it is first initialized with the default value.

pub fn metadata_cap_id_opt(&self) -> Option<&str>

If metadata_cap_id is set, returns Some with the value; otherwise returns None.

pub fn set_metadata_cap_id<T: Into<String>>(&mut self, field: T)

Sets metadata_cap_id with the provided value.

pub fn with_metadata_cap_id<T: Into<String>>(self, field: T) -> Self

Sets metadata_cap_id with the provided value.

pub fn with_metadata_cap_state<T: Into<MetadataCapState>>( self, field: T, ) -> Self

Sets metadata_cap_state with the provided value.

impl CoinMetadata

pub fn id(&self) -> &str

Returns the value of id, or the default value if id is unset.

pub fn decimals(&self) -> u32

Returns the value of decimals, or the default value if decimals is unset.

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn symbol(&self) -> &str

Returns the value of symbol, or the default value if symbol is unset.

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn icon_url(&self) -> &str

Returns the value of icon_url, or the default value if icon_url is unset.

pub fn metadata_cap_id(&self) -> &str

Returns the value of metadata_cap_id, or the default value if metadata_cap_id is unset.

pub fn metadata_cap_state(&self) -> MetadataCapState

Returns the enum value of metadata_cap_state, or the default if the field is unset or set to an invalid enum value.

pub fn set_metadata_cap_state(&mut self, value: MetadataCapState)

Sets metadata_cap_state to the provided enum value.

Trait Implementations

impl Clone for CoinMetadata

fn clone(&self) -> CoinMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinMetadata

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

Formats the value using the given formatter.

impl Default for CoinMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CoinMetadata

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CoinMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for CoinMetadata

const FIELDS: &'static [&'static MessageField]

impl PartialEq for CoinMetadata

fn eq(&self, other: &CoinMetadata) -> 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 Serialize for CoinMetadata

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CoinMetadata