Struct OptionalI32 

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

A signed number that may be absent.

Sequence positions and the depositor’s own residue numbers use this: both are genuinely optional, and both may legitimately be negative, so the reserved value is the one no numbering scheme reaches.

Examples

use molframe_core::OptionalI32;

assert_eq!(OptionalI32::some(-5).get(), Some(-5));
assert_eq!(OptionalI32::NONE.get(), None);
assert_eq!(size_of::<OptionalI32>(), 4);

Implementations

impl OptionalI32

pub const NONE: Self

The value is absent.

pub const fn some(value: i32) -> Self

Wraps a present value.

The reserved value maps to absent, which is the only lossy case and is unreachable for any real numbering.

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

The value, if present.

pub const fn is_none(self) -> bool

Returns true when no value is held.

pub const fn is_some(self) -> bool

Returns true when a value is held.

Trait Implementations

impl Clone for OptionalI32

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 OptionalI32

impl Debug for OptionalI32

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

Formats the value using the given formatter.

impl Default for OptionalI32

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OptionalI32

impl From<Option<i32>> for OptionalI32

fn from(value: Option<i32>) -> Self

Converts to this type from the input type.

impl From<OptionalI32> for Option<i32>

fn from(optional: OptionalI32) -> Self

Converts to this type from the input type.

impl Hash for OptionalI32

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 OptionalI32

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 OptionalI32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OptionalI32

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 OptionalI32