Struct Atom 

pub struct Atom { /* private fields */ }

An interned string associated with a particular string in a StringPool.

Allows for $O(1)$ equality tests, $O(1)$ hashing, and $O(1)$ arbitrary-but-stable ordering.

Implementations

impl Atom

pub fn index(&self) -> usize

Get this atom’s index in its pool.

Trait Implementations

impl Clone for Atom

fn clone(&self) -> Atom

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Atom

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

Formats the value using the given formatter.

impl Default for Atom

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Atom

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EntityRef for Atom

fn new(index: usize) -> Self

Create a new entity reference from a small integer. This should crash if the requested index is not representable.

fn index(self) -> usize

Get the index that was used to create this entity reference.

impl Hash for Atom

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 Index<&Atom> for StringPool

type Output = str

The returned type after indexing.

fn index(&self, atom: &Atom) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Atom> for StringPool

type Output = str

The returned type after indexing.

fn index(&self, atom: Atom) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for Atom

fn cmp(&self, other: &Atom) -> 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 Atom

fn eq(&self, other: &Atom) -> 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 Atom

fn partial_cmp(&self, other: &Atom) -> 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 Serialize for Atom

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryClone for Atom

fn try_clone(&self) -> Result<Self, OutOfMemory>

Attempt to clone self, returning an error if any allocation fails during cloning.

fn clone_panic_on_oom(&self) -> Self

Clone self, panicking on allocation failure.

impl Copy for Atom

impl Eq for Atom

impl StructuralPartialEq for Atom