Struct OptionalSymbol 

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

An interned identifier that may be absent.

Examples

use molframe_core::{Interner, OptionalSymbol};

let mut interner = Interner::new();
let present = OptionalSymbol::some(interner.intern("A")?);

assert!(present.get().is_some());
assert_eq!(OptionalSymbol::NONE.get(), None);
assert_eq!(size_of::<OptionalSymbol>(), 4);

Implementations

impl OptionalSymbol

pub const NONE: Self

The value is absent.

pub const fn some(symbol: SymbolId) -> Self

Wraps a present identifier.

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

The identifier, if present.

pub const fn is_none(self) -> bool

Returns true when no identifier is held.

pub const fn is_some(self) -> bool

Returns true when an identifier is held.

Trait Implementations

impl Clone for OptionalSymbol

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 OptionalSymbol

impl Debug for OptionalSymbol

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

Formats the value using the given formatter.

impl Default for OptionalSymbol

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OptionalSymbol

impl From<Option<SymbolId>> for OptionalSymbol

fn from(symbol: Option<SymbolId>) -> Self

Converts to this type from the input type.

impl From<OptionalSymbol> for Option<SymbolId>

fn from(optional: OptionalSymbol) -> Self

Converts to this type from the input type.

impl Hash for OptionalSymbol

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 OptionalSymbol

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 OptionalSymbol

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OptionalSymbol

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 OptionalSymbol