Struct Sigma

pub struct Sigma<Raw: Debug, Invariant: Test<Raw>> { /* private fields */ }

Type that maintains a given invariant.

Implementations

impl<Raw: Debug, Invariant: Test<Raw>> Sigma<Raw, Invariant>

pub fn check(&self)

Create a new sigma type instance by checking an invariant if and only if debug assertions are enabled.

Panics

If the invariant does not hold and debug assertions are enabled.

pub fn get(self) -> Raw

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn get_by<Y, F: FnOnce(Raw) -> Y>(self, f: F) -> Y

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn get_by_mut<Y, F: FnOnce(&mut Raw) -> Y>(&mut self, f: F) -> Y

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn get_by_ref<Y, F: FnOnce(&Raw) -> Y>(&self, f: F) -> Y

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn get_mut(&mut self) -> &mut Raw

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn get_ref(&self) -> &Raw

Unwrap the internal value that satisfies the invariant. If you’re using this to create another value that should also maintain an invariant, use map instead.

pub fn map<OtherRaw: Debug, OtherInvariant: Test<OtherRaw>, F: FnOnce(Raw) -> OtherRaw>( self, f: F, ) -> Sigma<OtherRaw, OtherInvariant>

Apply a function to a term that implements a given invariant (say, A), then check the output for a (possibly different) invariant (say, B).

pub fn map_ref<OtherRaw: Debug, OtherInvariant: Test<OtherRaw>, F: FnOnce(&Raw) -> OtherRaw>( &self, f: F, ) -> Sigma<OtherRaw, OtherInvariant>

Apply a function to a term that implements a given invariant (say, A), then check the output for a (possibly different) invariant (say, B).

pub fn modify<Y, F: FnOnce(&mut Raw) -> Y>(&mut self, f: F) -> Y

Apply a function that mutates this value, then check that the operation maintained this invariant.

pub fn new(raw: Raw) -> Self

Create a new sigma type instance by checking an invariant.

Panics

If the invariant does not hold and debug assertions are enabled.

Trait Implementations

impl<Raw: Clone + Debug, Invariant: Clone + Test<Raw>> Clone for Sigma<Raw, Invariant>

fn clone(&self) -> Sigma<Raw, Invariant>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Raw: Debug + Debug, Invariant: Debug + Test<Raw>> Debug for Sigma<Raw, Invariant>

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

Formats the value using the given formatter.

impl<Raw: Default + Debug, Invariant: Default + Test<Raw>> Default for Sigma<Raw, Invariant>

fn default() -> Sigma<Raw, Invariant>

Returns the “default value” for a type.

impl<Raw: Debug, Invariant: Test<Raw>> Deref for Sigma<Raw, Invariant>

type Target = Raw

The resulting type after dereferencing.

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

Dereferences the value.

impl<Raw: Hash + Debug, Invariant: Hash + Test<Raw>> Hash for Sigma<Raw, Invariant>

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<Raw: Ord + Debug, Invariant: Ord + Test<Raw>> Ord for Sigma<Raw, Invariant>

fn cmp(&self, other: &Sigma<Raw, Invariant>) -> 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<Raw: PartialEq + Debug, Invariant: PartialEq + Test<Raw>> PartialEq for Sigma<Raw, Invariant>

fn eq(&self, other: &Sigma<Raw, Invariant>) -> 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<Raw: PartialOrd + Debug, Invariant: PartialOrd + Test<Raw>> PartialOrd for Sigma<Raw, Invariant>

fn partial_cmp(&self, other: &Sigma<Raw, Invariant>) -> 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<Raw: Copy + Debug, Invariant: Copy + Test<Raw>> Copy for Sigma<Raw, Invariant>

impl<Raw: Eq + Debug, Invariant: Eq + Test<Raw>> Eq for Sigma<Raw, Invariant>

impl<Raw: Debug, Invariant: Test<Raw>> StructuralPartialEq for Sigma<Raw, Invariant>