Struct AltId 

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

An alternate-location label.

The blank label means “this atom belongs to every conformation” — a residue routinely mixes blank-labelled backbone atoms with labelled side-chain ones, which is exactly why picking the highest-occupancy atom one at a time can assemble a conformation that was never modelled.

A label of any length is representable, because refusing to truncate applies to labels as much as to chain identifiers.

Examples

use molframe_core::{AltId, Interner};

let mut interner = Interner::new();
let a = AltId::labelled(interner.intern("A")?);
assert!(a.is_some_and(|label| !label.is_blank()));
assert!(AltId::BLANK.is_blank());

Implementations

impl AltId

pub const BLANK: Self

The label carried by an atom present in every conformation.

pub const fn labelled(symbol: SymbolId) -> Option<Self>

Creates a label from an interned string.

Identifiers emitted by crate::Interner are guaranteed to fit this offset encoding without overflowing.

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

pub const fn is_blank(self) -> bool

Returns true for the blank label.

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

pub const fn symbol(self) -> Option<SymbolId>

The interned label, or None when blank.

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

pub const fn get(self) -> u32

The raw value, for storage in a column.

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

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

Rebuilds a label from a stored value.

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

Trait Implementations

impl Clone for AltId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AltId

impl Debug for AltId

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

Formats the blank label or its underlying symbol.

Runs in O(1) structural work plus the cost of formatting the symbol, and allocates no intermediate heap storage.

impl Default for AltId

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AltId

impl Hash for AltId

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 AltId

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 AltId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AltId

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 AltId