Struct Sigma

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

Type that maintains a given invariant.

Implementations

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

pub fn also<OtherInvariant: Test<Raw, 1>>(&self) -> &Sigma<Raw, OtherInvariant>

Without changing its internal value, view one sigma-typed value as implementing another sigma type by checking the latter invariant at runtime (iff debug assertions are enabled).

Panics

If the latter invariant does not hold.

pub fn check(&self)

Check 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 const 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 map<OtherRaw: Debug, OtherInvariant: Test<OtherRaw, 1>, 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, 1>, 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.

pub fn try_also<OtherInvariant: Test<Raw, 1>>( &self, ) -> Result<&Sigma<Raw, OtherInvariant>, OtherInvariant::Error<'_>>

Without changing its internal value, try to view one sigma-typed value as implementing another sigma type by checking the latter invariant at runtime.

Errors

If the latter invariant does not hold.

pub fn try_check(&self) -> Result<(), Invariant::Error<'_>>

Check an invariant without panicking.

Errors

If the invariant does not hold.

pub fn try_new(raw: Raw) -> Option<Self>

Create a new sigma type instance by checking an invariant.

Errors

If the invariant does not hold.

Trait Implementations

impl<Raw: Debug, Invariant: Test<Raw, 1>> AsRef<Raw> for Sigma<Raw, Invariant>

fn as_ref(&self) -> &Raw

Converts this type into a shared reference of the (usually inferred) input type.

impl<Raw: Debug, Invariant: Test<Raw, 1>> Borrow<Raw> for Sigma<Raw, Invariant>

fn borrow(&self) -> &Raw

Immutably borrows from an owned value.

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

type Target = Raw

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)

Feeds a slice of this type into the given Hasher.

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

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests less than (for self and other) and is used by the < operator.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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