Struct Symbol

pub struct Symbol { /* private fields */ }

Symbol is a short string with a limited character set.

Valid characters are a-zA-Z0-9_ and maximum length is 32 characters.

Symbols are used for the for symbolic identifiers, such as function names and user-defined structure field/enum variant names. That’s why these idenfiers have limited length.

While Symbols up to 32 characters long are allowed, Symbols that are 9 characters long or shorter are more efficient at runtime and also can be computed at compile time.

Implementations

impl Symbol

pub fn new(env: &Env, s: &str) -> Self

Creates a new Symbol given a string with valid characters.

Valid characters are a-zA-Z0-9_ and maximum string length is 32 characters.

Use symbol_short! for constant symbols that are 9 characters or less.

Use Symbol::try_from_val(env, s)/s.try_into_val(env) in case if failures need to be handled gracefully.

Panics

When the input string is not representable by Symbol.

pub fn as_val(&self) -> &Val

pub fn to_val(&self) -> Val

pub fn to_symbol_val(&self) -> SymbolVal

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

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

Formats the value using the given formatter.

impl From<&Symbol> for ScVal

fn from(v: &Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for ScVal

fn from(v: Symbol) -> Self

Converts to this type from the input type.

impl Ord for Symbol

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 Symbol

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 Symbol

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

Available on crate feature testutils only.

type Prototype = ArbitrarySymbol

A type that implements Arbitrary and can be converted to this SorobanArbitrary type.

impl ToString for Symbol

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFromVal<Env, &Symbol> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &&Symbol) -> Result<Self, Self::Error>

impl TryFromVal<Env, &str> for Symbol

type Error = ConversionError

fn try_from_val(env: &Env, val: &&str) -> Result<Self, Self::Error>

impl TryFromVal<Env, ScSymbol> for Symbol

type Error = ConversionError

fn try_from_val(env: &Env, val: &ScSymbol) -> Result<Self, Self::Error>

impl TryFromVal<Env, ScVal> for Symbol

type Error = ConversionError

fn try_from_val(env: &Env, val: &ScVal) -> Result<Self, Self::Error>

impl TryFromVal<Env, Symbol> for ScVal

type Error = ConversionError

fn try_from_val(_e: &Env, v: &Symbol) -> Result<Self, ConversionError>

impl TryFromVal<Env, Symbol> for Symbol

type Error = Infallible

fn try_from_val(env: &Env, val: &SymbolVal) -> Result<Self, Self::Error>

impl TryFromVal<Env, Symbol> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &Symbol) -> Result<Self, Self::Error>

impl TryFromVal<Env, Val> for Symbol

type Error = ConversionError

fn try_from_val(env: &Env, val: &Val) -> Result<Self, Self::Error>

impl Eq for Symbol