logo
pub struct Symbol(_);
Expand description

Identifier bound to an interned byte string.

A Symbol allows retrieving a reference to the original interned byte string. Equivalent Symbols will resolve to an identical byte string.

Symbols are based on a u32 index. They are cheap to compare and cheap to copy.

Symbols are not constrained to the interner which created them.

Implementations

Construct a new Symbol from the given u32.

Symbols constructed manually may fail to resolve to an underlying byte string.

Symbols are not constrained to the interner which created them. No runtime checks ensure that the underlying interner is called with a Symbol that the interner itself issued.

Examples
let sym = Symbol::new(263);
assert_eq!(sym.id(), 263);

Return the u32 identifier from this Symbol.

Examples
let sym = Symbol::new(263);
assert_eq!(sym.id(), 263);
assert_eq!(u32::from(sym), 263);

Returns whether the symbol is the empty byte slice b"" in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, true is returned.

Returns the length of the byte slice associated with the symbol in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, 0 is returned.

Returns the interned byte slice associated with the symbol in the underlying interner.

If there symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, &[] is returned.

Returns an iterator that yields a debug representation of the interned byte slice associated with the symbol in the underlying interner.

This iterator produces char sequences like :spinoso and :"invalid-\xFF-utf8".

This function can be used to implement the Ruby method Symbol#inspect.

If the symbol does not exist in the underlying interner or there is an error looking up the symbol in the underlying interner, a default iterator is returned.

Trait Implementations

Immutably borrows from an owned value. Read more

Safety Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

This method returns an ordering between self and other values if one exists. Read more

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

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

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.