Struct soroban_sdk::Symbol

pub struct Symbol(_);

Symbol reprents strings up to 10 characters long with a a-zA-Z0-9_ alphabet encoded into a 60-bit space between 10 characters long.

Wrapper for a RawVal that is tagged with [Tag::Symbol], interpreting the RawVal’s body as a 60-bit small “string-like” object, 10 characters or less and with characters drawn from the 64-character repertoire a-zA-Z0-9_.

Implementations

impl Symbol

pub const fn as_raw(&self) -> &RawVal

pub const fn to_raw(&self) -> RawVal

pub fn in_env<E>(self, env: &E) -> EnvVal<E, Symbol>where
    E: Env,

impl Symbol

pub const fn try_from_bytes(b: &[u8]) -> Result<Symbol, SymbolError>

pub const fn try_from_str(s: &str) -> Result<Symbol, SymbolError>

pub const fn from_str(s: &str) -> Symbol

pub fn to_str(&self) -> SymbolStr

Trait Implementations

impl AsMut<RawVal> for Symbol

fn as_mut(&mut self) -> &mut RawVal

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsMut<Symbol> for EnvVal<E, Symbol>where
    E: Env,

fn as_mut(&mut self) -> &mut Symbol

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<RawVal> for Symbol

fn as_ref(&self) -> &RawVal

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> AsRef<Symbol> for EnvVal<E, Symbol>where
    E: Env,

fn as_ref(&self) -> &Symbol

Converts this type into a shared reference of the (usually inferred) input type.

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 Debug for Symbol

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

Formats the value using the given formatter.

impl From<&Symbol> for SymbolStr

fn from(s: &Symbol) -> SymbolStr

Converts to this type from the input type.

impl<E> From<EnvVal<E, Symbol>> for Symbolwhere
    E: Env,

fn from(ev: EnvVal<E, Symbol>) -> Symbol

Converts to this type from the input type.

impl From<Symbol> for RawVal

fn from(b: Symbol) -> RawVal

Converts to this type from the input type.

impl From<Symbol> for SymbolStr

fn from(s: Symbol) -> SymbolStr

Converts to this type from the input type.

impl FromIterator<char> for Symbol

fn from_iter<T>(iter: T) -> Symbolwhere
    T: IntoIterator<Item = char>,

Creates a value from an iterator.

impl FromValue for Symbol

fn from_value(val: Value) -> Option<Symbol>

Create a value of type Self from a given Value.

impl Hash for Symbol

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

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 IntoIterator for Symbol

type Item = char

The type of the elements being iterated over.

type IntoIter = SymbolIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Symbol as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<E> IntoVal<E, RawVal> for &Symbolwhere
    E: Env,

fn into_val(self, _env: &E) -> RawVal

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E> IntoVal<E, RawVal> for Symbolwhere
    E: Env,

fn into_val(self, _env: &E) -> RawVal

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl Ord for Symbol

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl RawValConvertible for Symbol

fn is_val_type(v: RawVal) -> bool

Returns true if v is in a union state compatible with Self.

unsafe fn unchecked_from_val(v: RawVal) -> Symbol

Converts the bits making up a RawVal into Self without checking that the RawVal is tagged correctly, assuming that such a check has been performed elsewhere. It is the caller’s responsibility to arrange that such checks have occurred before calling unchecked_from_val, which is why it is marked as unsafe (it does not represent a risk of memory-unsafety, merely “serious logic errors”).

fn try_convert(v: RawVal) -> Option<Self>

Attempt a conversion from RawVal to Self, returning None if the provided RawVal is not tagged correctly. By default this calls Self::is_val_type and Self::unchecked_from_val, but it can be customized on a type-by-type basis to avoid redundant tag tests and produce more efficient code, as it is done for Static values like bool.

impl ToString for Symbol

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&[u8]> for Symbol

type Error = SymbolError

The type returned in the event of a conversion error.

fn try_from(b: &[u8]) -> Result<Symbol, SymbolError>

Performs the conversion.

impl TryFrom<&RawVal> for Symbol

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &RawVal) -> Result<Symbol, <Symbol as TryFrom<&RawVal>>::Error>

Performs the conversion.

impl TryFrom<&ScVal> for Symbol

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &ScVal) -> Result<Symbol, <Symbol as TryFrom<&ScVal>>::Error>

Performs the conversion.

impl<const N: u32> TryFrom<&StringM<N>> for Symbol

type Error = SymbolError

The type returned in the event of a conversion error.

fn try_from(
    v: &StringM<N>
) -> Result<Symbol, <Symbol as TryFrom<&StringM<N>>>::Error>

Performs the conversion.

impl TryFrom<&Symbol> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(s: &Symbol) -> Result<ScVal, <ScVal as TryFrom<&Symbol>>::Error>

Performs the conversion.

impl TryFrom<RawVal> for Symbol

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: RawVal) -> Result<Symbol, <Symbol as TryFrom<RawVal>>::Error>

Performs the conversion.

impl TryFrom<ScVal> for Symbol

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: ScVal) -> Result<Symbol, <Symbol as TryFrom<ScVal>>::Error>

Performs the conversion.

impl<const N: u32> TryFrom<StringM<N>> for Symbol

type Error = SymbolError

The type returned in the event of a conversion error.

fn try_from(
    v: StringM<N>
) -> Result<Symbol, <Symbol as TryFrom<StringM<N>>>::Error>

Performs the conversion.

impl TryFrom<Symbol> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(s: Symbol) -> Result<ScVal, <ScVal as TryFrom<Symbol>>::Error>

Performs the conversion.

impl<E> TryFromVal<E, RawVal> for Symbolwhere
    E: Env,

type Error = ConversionError

fn try_from_val(
    _env: &E,
    val: RawVal
) -> Result<Symbol, <Symbol as TryFromVal<E, RawVal>>::Error>

impl<E> TryIntoVal<E, RawVal> for Symbolwhere
    E: Env,

type Error = ConversionError

fn try_into_val(
    self,
    _env: &E
) -> Result<RawVal, <Symbol as TryIntoVal<E, RawVal>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<E> TryIntoVal<E, Symbol> for RawValwhere
    E: Env,

type Error = ConversionError

fn try_into_val(
    self,
    env: &E
) -> Result<Symbol, <RawVal as TryIntoVal<E, Symbol>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl Copy for Symbol

impl Eq for Symbol

impl Val for Symbol