Struct Refinement

pub struct Refinement<T, P>(/* private fields */);

A Refinement type ensures all values of a particular type satisfy a Predicate.

Use as_inner/to_inner to access the underlying value or into_inner to unwrap the value.

Refinement also implements many common standard library traits if the underlying value also implements them.

Examples

use refinement::{Predicate, Refinement};

struct LessThanTen;

impl Predicate<i32> for LessThanTen {
    fn test(x: &i32) -> bool {
        *x < 10
    }
}

type LessThanTenInt = Refinement<i32, LessThanTen>;

let x = LessThanTenInt::new(5);
assert!(x.is_some());

let y = LessThanTenInt::new(11);
assert!(y.is_none());

Implementations

impl<T, P> Refinement<T, P>

where P: Predicate<T>,

pub fn new(x: T) -> Option<Self>

Create a refined value from the underlying type T.

Returns x under the refinement type if x satisfies P, otherwise returns None.

Examples

use refinement::{Predicate, Refinement};

struct NonEmpty;

impl Predicate<String> for NonEmpty {
    fn test(x: &String) -> bool {
       !x.is_empty()
    }
}

type NonEmptyString = Refinement<String, NonEmpty>;

let s1 = NonEmptyString::new(String::from("Hello"));
assert!(s1.is_some());

let s2 = NonEmptyString::new(String::from(""));
assert!(s2.is_none());

pub fn into_inner(self) -> T

Unwrap the underlying value, consuming self.

Examples

use refinement::{Predicate, Refinement};

struct ThreeDigit;

impl Predicate<String> for ThreeDigit {
    fn test(x: &String) -> bool {
       x.chars().count() == 3 && x.chars().filter(|c| c.is_ascii_digit()).count() == 3
    }
}

type ThreeDigitString = Refinement<String, ThreeDigit>;

let s = ThreeDigitString::new(String::from("123"));

assert_eq!(String::from("123"), s.unwrap().into_inner());

impl<T, P> Refinement<T, P>

where T: Clone, P: Predicate<T>,

pub fn to_inner(&self) -> T

Retrieve the underlying value without consuming self.

Examples

use refinement::{Predicate, Refinement};

struct ThreeDigit;

impl Predicate<String> for ThreeDigit {
    fn test(x: &String) -> bool {
       x.chars().count() == 3 && x.chars().filter(|c| c.is_ascii_digit()).count() == 3
    }
}

type ThreeDigitString = Refinement<String, ThreeDigit>;

let s = ThreeDigitString::new(String::from("123"));

assert_eq!(String::from("123"), s.unwrap().to_inner());

impl<T, P> Refinement<T, P>

where T: Copy, P: Predicate<T>,

pub fn as_inner(&self) -> T

Retrieve the underlying value for Copy types without consuming self.

Examples

use refinement::{Predicate, Refinement};

struct LessThanTen;

impl Predicate<i32> for LessThanTen {
    fn test(x: &i32) -> bool {
        *x < 10
    }
}

type LessThanTenInt = Refinement<i32, LessThanTen>;

let x = LessThanTenInt::new(5);
assert_eq!(5, x.unwrap().as_inner());

Trait Implementations

impl<T, P> Add<T> for Refinement<T, P>

where T: Add<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T, P> Add for Refinement<T, P>

where T: Add<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T, P> AsRef<T> for Refinement<T, P>

where P: Predicate<T>,

fn as_ref(&self) -> &T

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

impl<T, P> BitAnd<T> for Refinement<T, P>

where T: BitAnd<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the & operator.

fn bitand(self, rhs: T) -> Self::Output

Performs the & operation.

impl<T, P> BitAnd for Refinement<T, P>

where T: BitAnd<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<T, P> BitOr<T> for Refinement<T, P>

where T: BitOr<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the | operator.

fn bitor(self, rhs: T) -> Self::Output

Performs the | operation.

impl<T, P> BitOr for Refinement<T, P>

where T: BitOr<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<T, P> BitXor<T> for Refinement<T, P>

where T: BitXor<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: T) -> Self::Output

Performs the ^ operation.

impl<T, P> BitXor for Refinement<T, P>

where T: BitXor<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<T, P> Borrow<T> for Refinement<T, P>

where P: Predicate<T>,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Clone, P> Clone for Refinement<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, P> Debug for Refinement<T, P>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, P> Deref for Refinement<T, P>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, P> DerefMut for Refinement<T, P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, P> Display for Refinement<T, P>

where T: Display, P: Predicate<T>,

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

Formats the value using the given formatter.

impl<T, P> Div<T> for Refinement<T, P>

where T: Div<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T, P> Div for Refinement<T, P>

where T: Div<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<T: Hash, P: Hash> Hash for Refinement<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, P, I> Index<I> for Refinement<T, P>

where T: Index<I>, P: Predicate<T>,

type Output = <T as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, P> Mul<T> for Refinement<T, P>

where T: Mul<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T, P> Mul for Refinement<T, P>

where T: Mul<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T, P> Neg for Refinement<T, P>

where T: Neg<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T, P> Not for Refinement<T, P>

where T: Not<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: Ord, P: Ord> Ord for Refinement<T, P>

fn cmp(&self, other: &Refinement<T, P>) -> 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: PartialEq> PartialEq for Refinement<T, P>

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

fn partial_cmp(&self, other: &Refinement<T, P>) -> 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, P, B> RangeBounds<B> for Refinement<T, P>

where T: RangeBounds<B>, P: Predicate<T>,

fn start_bound(&self) -> Bound<&B>

Start index bound.

fn end_bound(&self) -> Bound<&B>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl<T, P> Rem<T> for Refinement<T, P>

where T: Rem<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T, P> Rem for Refinement<T, P>

where T: Rem<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl<T, P> Shl<T> for Refinement<T, P>

where T: Shl<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the << operator.

fn shl(self, rhs: T) -> Self::Output

Performs the << operation.

impl<T, P> Shl for Refinement<T, P>

where T: Shl<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the << operator.

fn shl(self, rhs: Self) -> Self::Output

Performs the << operation.

impl<T, P> Shr<T> for Refinement<T, P>

where T: Shr<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the >> operator.

fn shr(self, rhs: T) -> Self::Output

Performs the >> operation.

impl<T, P> Shr for Refinement<T, P>

where T: Shr<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the >> operator.

fn shr(self, rhs: Self) -> Self::Output

Performs the >> operation.

impl<T, P> Sub<T> for Refinement<T, P>

where T: Sub<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T, P> Sub for Refinement<T, P>

where T: Sub<Output = T>, P: Predicate<T>,

type Output = Option<Refinement<T, P>>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<T: Copy, P> Copy for Refinement<T, P>

impl<T: Eq, P: Eq> Eq for Refinement<T, P>

impl<T, P> StructuralPartialEq for Refinement<T, P>