Struct StaticSymbol

pub struct StaticSymbol(/* private fields */);

Const-compatible static symbol.

This type is created by the static_sym!(...) macro, and can be used in const contexts. See the macro documentation for more details.

CAUTION: Declarations with StaticSymbol must not be used before static initializers have run, i.e. before main().

Methods from Deref<Target = Symbol>

pub fn as_str(&self) -> &'static str

Get the string representation of this symbol.

This operation is guaranteed to not take any locks, and is effectively free.

pub fn inner(&self) -> &'static &'static str

Get the underlying representation of this symbol.

pub fn as_ptr(&self) -> NonNull<&'static str>

Get the underlying pointer value of this symbol.

This is the basis for computing equality and hashes. Symbols representing the same string always have the same pointer value.

pub fn to_ffi(&self) -> u64

Convert the symbol to an FFI-friendly u64.

pub fn len(&self) -> usize

Length of the underlying string.

pub fn is_empty(&self) -> bool

Whether or not this is the empty symbol.

Trait Implementations

impl AsRef<Symbol> for StaticSymbol

fn as_ref(&self) -> &Symbol

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

impl Borrow<Symbol> for StaticSymbol

fn borrow(&self) -> &Symbol

Immutably borrows from an owned value.

impl Clone for StaticSymbol

fn clone(&self) -> StaticSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StaticSymbol

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

Formats the value using the given formatter.

impl Deref for StaticSymbol

type Target = Symbol

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for StaticSymbol

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

Formats the value using the given formatter.

impl From<&StaticSymbol> for Symbol

fn from(value: &StaticSymbol) -> Self

Converts to this type from the input type.

impl From<StaticSymbol> for Symbol

fn from(value: StaticSymbol) -> Self

Converts to this type from the input type.

impl PartialEq<StaticSymbol> for Symbol

fn eq(&self, other: &StaticSymbol) -> 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 PartialEq<Symbol> for StaticSymbol

fn eq(&self, other: &Symbol) -> 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 PartialEq for StaticSymbol

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 Copy for StaticSymbol