Struct CoinMetadata

pub struct CoinMetadata<T: MoveType> {
    pub id: UID,
    pub decimals: u8,
    pub name: String,
    pub symbol: String,
    pub description: String,
    pub icon_url: Option<Url>,
    /* private fields */
}

Each Coin type T created through create_currency function will have a unique instance of CoinMetadata<T> that stores the metadata for this coin type.

Fields

id: UID

decimals: u8

Number of decimal places the coin uses. A coin with value N and decimals D should be shown as N / 10^D E.g., a coin with value 7002 and decimals 3 should be displayed as 7.002 This is metadata for display usage only.

name: String

Name for the token

symbol: String

Symbol for the token

description: String

Description of the token

icon_url: Option<Url>

URL for the token logo

Implementations

impl<T: MoveType> CoinMetadata<T>

pub fn new( id: UID, decimals: u8, name: String, symbol: String, description: String, icon_url: Option<Url>, ) -> Self

Constructs a new CoinMetadata.

impl<T: MoveType> CoinMetadata<T>

pub fn move_instance(self, t: <T as MoveType>::TypeTag) -> MoveInstance<Self>

pub fn type_(t: <T as MoveType>::TypeTag) -> CoinMetadataTypeTag<T>

Trait Implementations

impl<T: Clone + MoveType> Clone for CoinMetadata<T>

fn clone(&self) -> CoinMetadata<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + MoveType> Debug for CoinMetadata<T>

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

Formats the value using the given formatter.

impl<'de, T: MoveType> Deserialize<'de> for CoinMetadata<T>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: MoveType> Display for CoinMetadata<T>

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

Formats the value using the given formatter.

impl<T: MoveType> HasKey for CoinMetadata<T>

fn object_id(&self) -> ObjectId

impl<T: Hash + MoveType> Hash for CoinMetadata<T>

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<T: MoveType> MoveStruct for CoinMetadata<T>

type StructTag = CoinMetadataTypeTag<T>

impl<T: MoveType> MoveType for CoinMetadata<T>

type TypeTag = CoinMetadataTypeTag<T>

fn from_bcs(bytes: &[u8]) -> Result<Self, Error>

Deserialize the contents of the Move type from BCS bytes.

fn into_bcs(self) -> Result<Vec<u8>, Error>

Consuming version of to_bcs.

fn to_bcs(&self) -> Result<Vec<u8>, Error>

Serialize the contents of the Move type to BCS bytes.

fn into_json(self) -> Value

Consuming version of to_json.

fn to_json(&self) -> Value

Serialize the contents of the Move type to JSON.

impl<T: PartialEq + MoveType> PartialEq for CoinMetadata<T>

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: MoveType> StaticAddress for CoinMetadata<T>

fn address() -> Address

impl<T: MoveType> StaticModule for CoinMetadata<T>

fn module() -> Identifier

impl<T: MoveType> StaticName for CoinMetadata<T>

fn name() -> Identifier

impl<T: MoveType + StaticTypeTag> StaticTypeParams for CoinMetadata<T>

fn type_params() -> Vec<TypeTag>

impl<T: MoveType> Tabled for CoinMetadata<T>

const LENGTH: usize = 6usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<Cow<'_, str>>

Fields method must return a list of cells.

fn headers() -> Vec<Cow<'static, str>>

Headers must return a list of column names.

impl<T: Eq + MoveType> Eq for CoinMetadata<T>

impl<T: MoveType> StructuralPartialEq for CoinMetadata<T>