Struct SymbolId 

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

An interned identifier.

Identifiers below the canonical count mean the same string in every structure. Above it they are meaningful only against the interner that issued them.

Examples

use molframe_core::{Interner, SymbolId};

let mut interner = Interner::new();
let alanine = interner.intern("ALA")?;
assert!(alanine.is_canonical());

let ligand = interner.intern("MY_LIGAND")?;
assert!(!ligand.is_canonical());
assert_eq!(interner.resolve(ligand), Some("MY_LIGAND"));

Implementations

impl SymbolId

pub fn is_canonical(self) -> bool

Returns true when this identifier has the same meaning in every structure, so comparing it across structures is sound.

Runs in O(1) time and allocates no memory.

pub const fn get(self) -> u32

The raw identifier, for storage in a column.

Runs in O(1) time and allocates no memory.

pub const fn from_raw(raw: u32) -> Self

Rebuilds an identifier from a stored value.

u32::MAX is reserved and is not emitted by Interner. Callers should pass values previously produced by this crate.

Runs in O(1) time and allocates no memory.

Trait Implementations

impl Clone for SymbolId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColumnValue for SymbolId

const IS_INTEGER: bool = true

Whether the bit pattern is an integer, so that narrowing it or taking differences between successive values means something.

fn to_bits(self) -> u64

The value as bits.

fn from_bits(bits: u64) -> Option<Self>

The value from bits.

impl Copy for SymbolId

impl Debug for SymbolId

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

Formats canonical identifiers by text and local identifiers by raw value.

Runs in O(L) formatting time for canonical text of length L and allocates no intermediate heap storage.

impl Eq for SymbolId

impl Hash for SymbolId

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 Ord for SymbolId

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for SymbolId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolId

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for SymbolId