Struct Atom

pub struct Atom(pub usize);

A simple type to represent atoms: a wrapper around unsigned integers. Implements Deref to usize for ease of use. In terms of being parsed, any atom less than 26 maps to a corresponding lowercase letter and those from 26..52 map to the corresponding uppercase letter. If for whatever reason you need more than 52 atoms, then they can only be printed/parsed as the corresponding numbers.

Tuple Fields

0: usize

Methods from Deref<Target = usize>

pub const MIN: usize = 0usize

pub const MAX: usize = 18_446_744_073_709_551_615usize

pub const BITS: u32 = 64u32

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

Returns the “default value” for a type.

impl Deref for Atom

type Target = usize

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Atom

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Atom

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

Formats the value using the given formatter.

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 Match for Atom

fn match_str(s: &str) -> Option<Self>

Given a string, return Self if the string matches some element of Self.

fn get_matches(&self) -> Vec<String>

Given an element of Self, return the corresponding strings as a vector.

fn match_prefix(s: &str) -> Option<(usize, Self)>

Match a prefix of a given string against the string matches. Uses the conventional max-munch principle: if the string is "orange" and "o" and "or" are both matches, the method will return "or".

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

impl Eq for Atom

impl StructuralPartialEq for Atom

impl Symbolic for Atom