Struct eosio::Symbol

pub struct Symbol(_);

Stores information about a symbol, the symbol can be 7 characters long.

Methods

impl Symbol

#[must_use] pub const fn new(value: u64) -> Self

Construct a new symbol given a value.

#[must_use] pub const fn new_with_code(precision: u8, code: SymbolCode) -> Self

Construct a new symbol given a u8 precision and SymbolCode.

#[must_use] pub const fn precision(&self) -> u8

This symbol's precision

#[must_use] pub const fn code(&self) -> SymbolCode

Returns representation of symbol name

Examples

use eosio::{s, Symbol};
let symbol: Symbol = s!(4, "EOS").into();
let code = symbol.code();
assert_eq!(code.to_string(), "EOS");

#[must_use] pub const fn as_u64(&self) -> u64

TODO docs

#[must_use] pub fn is_valid(&self) -> bool

Is this symbol valid

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Symbol

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Default for Symbol

fn default() -> Symbol

Returns the "default value" for a type.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl From<Symbol> for u64

#[must_use] fn from(n: Symbol) -> Self

Performs the conversion.

impl From<Symbol> for SecondaryKey

#[must_use] fn from(v: Symbol) -> Self

Performs the conversion.

impl From<Symbol> for ScopeName

#[must_use] fn from(value: Symbol) -> Self

Performs the conversion.

impl From<u64> for Symbol

#[must_use] fn from(n: u64) -> Self

Performs the conversion.

impl Hash for Symbol

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, 

Feeds a slice of this type into the given [Hasher].

impl NumBytes for Symbol

fn num_bytes(&self) -> usize

Count the number of bytes a type is expected to use.

impl Ord for Symbol

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Symbol> for Symbol

fn eq(&self, other: &Symbol) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Symbol) -> bool

This method tests for !=.

impl PartialEq<u64> for Symbol

#[must_use] fn eq(&self, other: &u64) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Symbol> for Symbol

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Read for Symbol

fn read(bytes: &[u8], pos: &mut usize) -> Result<Self, ReadError>

Read bytes.

fn unpack<T: AsRef<[u8]>>(bytes: T) -> Result<Self, ReadError>

Deserializes a byte array into a data type.

impl StructuralEq for Symbol

impl StructuralPartialEq for Symbol

impl Write for Symbol

fn write(&self, bytes: &mut [u8], pos: &mut usize) -> Result<(), WriteError>

Write bytes.

fn pack(&self) -> Result<Vec<u8>, WriteError>

Serializes data into a byte vector.