Struct Sigma 

#[repr(transparent)]
pub struct Sigma<T, P: Predicate<T>> {
    pub value: T,
    /* private fields */
}

Sigma-types: types whose terms satisfy a predicate (e.g. floats greater than zero).

Fields

value: T

A value of type T that additionally satisfies the predicate P.

Implementations

impl<T, P: Predicate<T>> Sigma<T, P>

pub fn new(candidate: T) -> Result<Self, (P::Error, T)>

Attempt to create a new term of this Sigma-type by checking the predicate and succeeding iff the predicate holds.

Errors

If the property does not hold for the candidate provided.

pub unsafe fn new_unchecked(candidate: T) -> Self

Attempt to create a new term of this Sigma-type by checking the predicate and succeeding iff the predicate holds.

Safety

Nonsensical value if the property does not hold for the candidate provided.

Panics

If debug assertions are enabled and P::check fails.

Trait Implementations

impl<T: Clone, P: Predicate<T>> Clone for Sigma<T, P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, P: Predicate<T>> Debug for Sigma<T, P>

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

Formats the value using the given formatter.

impl<T, P: Predicate<T>> Deref for Sigma<T, P>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Display, P: Predicate<T>> Display for Sigma<T, P>

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

Formats the value using the given formatter.

impl<T: Hash, P: Predicate<T>> Hash for Sigma<T, P>

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<T: Ord, P: Predicate<T>> Ord for Sigma<T, P>

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.

impl<T: PartialEq, P: Predicate<T>> PartialEq for Sigma<T, P>

fn eq(&self, other: &Self) -> 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<T: PartialOrd, P: Predicate<T>> PartialOrd for Sigma<T, P>

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<T: Pbt, P: Predicate<T>> Pbt for Sigma<T, P>

fn register_all_immediate_dependencies( visited: &mut BTreeSet<Type>, sccs: &mut StronglyConnectedComponents, )

Register the immediate dependencies of Self within the current type-registration traversal.

fn type_former() -> TypeFormer<Self>

The exhaustive disjoint set of methods to pbt a term of this type.

fn visit_deep<V: Pbt>(&self) -> impl Iterator<Item = V>

Visit all terms of type V in this abstract syntax tree. Your implementation should always follow this formula: pbt::pbt::visit_self(self).chain(... recurse into fields ...).

impl<T: Copy, P: Predicate<T>> Copy for Sigma<T, P>

impl<T: Eq, P: Predicate<T>> Eq for Sigma<T, P>