Struct gluon_base::symbol::Symbol

pub struct Symbol(_);

A symbol uniquely identifies something regardless of its name and which module it originated from

Methods

impl Symbol

pub fn strong_count(sym: &Symbol) -> usize

Methods from Deref<Target = SymbolRef>

pub fn name_eq(&self, other: &SymbolRef) -> bool

Checks whether the names of two symbols are equal

pub fn as_pretty_str(&self) -> &str

pub fn as_str(&self) -> &str

pub fn name(&self) -> &Name

pub fn raw_name(&self) -> &Name

pub fn declared_name(&self) -> &str

Returns the name of this symbol as it was originally declared (strips location information and module information)

pub fn definition_name(&self) -> &str

pub fn is_global(&self) -> bool

Trait Implementations

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.

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 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 ==.

#[must_use]

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

This method tests for !=.

impl AsRef<str> for Symbol

fn as_ref(&self) -> &str

Performs the conversion.

impl<S> From<S> for Symbol where
    S: Into<String>, 

fn from(name: S) -> Symbol

Performs the conversion.

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 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)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Symbol

impl Display for Symbol

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

Formats the value using the given formatter.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Hash for Symbol

fn hash<H: Hasher>(&self, h: &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 Deref for Symbol

type Target = SymbolRef

The resulting type after dereferencing.

fn deref(&self) -> &SymbolRef

Dereferences the value.

impl Borrow<SymbolRef> for Symbol

fn borrow(&self) -> &SymbolRef

Immutably borrows from an owned value.