Struct Refinement 

pub struct Refinement<T: ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized = NoContext> { /* private fields */ }

Represents refinement types.

Implementations

impl<T: ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Refinement<T, P, C>

pub const unsafe fn unchecked_ref(value: &T) -> &Self

Constructs Self by reference without checking.

Safety

This method should only be called for references that satisfy P, which can be checked via is_fine.

pub fn get_ref(&self) -> &T

Returns the contained value reference.

If the unsafe-assert feature is enabled, assert_unchecked is called on the reference before returning.

The get_ref_no_assert method is provided in case the assertion is explicitly not needed.

pub const fn get_ref_no_assert(&self) -> &T

Returns the contained value.

pub fn is_fine(value: &T) -> bool

Checks whether the provided value satisfies P.

This is the same as calling P::check on it.

pub fn checked_ref(value: &T) -> RecoverableRef<'_, Self, P, C, T>

Constructs Self by reference.

Errors

Returns Error<T, P, C> in case the reference does not satisfy P.

impl<T, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Refinement<T, P, C>

pub const unsafe fn unchecked(value: T) -> Self

Constructs Self without checking the value.

Safety

This method should only be called for values that satisfy the predicate P, which can be checked using is_fine.

pub fn get(self) -> T

Returns the contained value.

If the unsafe-assert feature is enabled, assert_unchecked is called on the reference before returning the value.

The get_no_assert method is provided in case the assertion is explicitly not needed.

pub fn get_no_assert(self) -> T

Returns the contained value.

pub fn checked(value: T) -> Recoverable<Self, P, C, T>

Constructs Self from the given value.

Errors

Returns Error<T, P, C> in case the value does not satisfy P.

Trait Implementations

impl<T: ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> AsRef<T> for Refinement<T, P, C>

fn as_ref(&self) -> &T

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

impl<T: Debug + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Debug for Refinement<T, P, C>

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

Formats the value using the given formatter.

impl<T: ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Deref for Refinement<T, P, C>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Display + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Display for Refinement<T, P, C>

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

Formats the value using the given formatter.

impl<T: Eq + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Eq for Refinement<T, P, C>

impl<T: Hash + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Hash for Refinement<T, P, C>

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 + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Ord for Refinement<T, P, C>

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 + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> PartialEq for Refinement<T, P, C>

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 + ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> PartialOrd for Refinement<T, P, C>

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: ?Sized, P: Predicate<T> + ?Sized, C: TypeStr + ?Sized> Refining for Refinement<T, P, C>

type Value = T

The refinement value (T in Refinement<T, P, C>).

type Predicate = P

The refinement predicate (P in Refinement<T, P, C>).

type Context = C

The refinement context (C in Refinement<T, P, C>).

unsafe fn unchecked_ref(value: &Self::Value) -> &Self

Constructs Self from Self::Value by reference without checking.

unsafe fn unchecked(value: Self::Value) -> Self

where Self::Value: Sized,

Constructs Self from Self::Value without checking.

fn is_fine(value: &Self::Value) -> bool

Checks whether the given Self::Value satisfies Self::Predicate.

fn get_ref(&self) -> &Self::Value

Returns the contained value reference.

fn get(self) -> Self::Value

where Self::Value: Sized,

Returns the contained value.

fn checked_ref(value: &Self::Value) -> RecoverableRefinementRef<'_, Self>

Constructs Self from Self::Value by reference.

fn checked(value: Self::Value) -> RecoverableRefinement<Self>

where Self::Value: Sized,

Constructs Self from Self::Value.