Enum SymbolKey 

#[non_exhaustive]
pub enum SymbolKey {
    U64(u64),
    Str(Arc<str>),
    Fresh(u64),
}

The identity of a symbol within a context.

Keys are opaque to bitwright. A key has exactly one width per context. The derived order (integers, then strings, then fresh keys) is part of the canonical operand order, so it is the same in every context.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

U64(u64)

An integer key chosen by the caller (for example a register or variable number).

Str(Arc<str>)

A name.

Fresh(u64)

A key from Context::fresh_symbol.

Trait Implementations

impl Clone for SymbolKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolKey

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

Formats the value using the given formatter.

impl Display for SymbolKey

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

The spelling used by the expression printer and accepted by the parser.

impl Eq for SymbolKey

impl From<&str> for SymbolKey

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Arc<str>> for SymbolKey

fn from(s: Arc<str>) -> Self

Converts to this type from the input type.

impl From<String> for SymbolKey

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<u64> for SymbolKey

fn from(k: u64) -> Self

Converts to this type from the input type.

impl Hash for SymbolKey

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 Ord for SymbolKey

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for SymbolKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolKey

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 StructuralPartialEq for SymbolKey