Struct refinement::Refinement

source · [−]

pub struct Refinement<T, P>(_, _);

Expand description

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

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());

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());

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

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

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

The resulting type after applying the + operator.

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

Performs the + operation. Read more

fn as_ref(&self) -> &T

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

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

The resulting type after applying the & operator.

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

Performs the & operation. Read more

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

The resulting type after applying the & operator.

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

Performs the & operation. Read more

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

The resulting type after applying the | operator.

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

Performs the | operation. Read more

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

The resulting type after applying the | operator.

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

Performs the | operation. Read more

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

The resulting type after applying the ^ operator.

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

Performs the ^ operation. Read more

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

The resulting type after applying the ^ operator.

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

Performs the ^ operation. Read more

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

Formats the value using the given formatter. Read more

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

Mutably dereferences the value.

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

Formats the value using the given formatter. Read more

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

The resulting type after applying the / operator.

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

Performs the / operation. Read more

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

The resulting type after applying the / operator.

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

Performs the / operation. Read more

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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. Read more

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

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

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

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation. Read more

fn cmp(&self, other: &Refinement<T, P>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

fn eq(&self, other: &Refinement<T, P>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

fn partial_cmp(&self, other: &Refinement<T, P>) -> Option<Ordering>

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

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

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

Start index bound. Read more

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

End index bound. Read more

1.35.0 · source

fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range. Read more

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

The resulting type after applying the % operator.

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

Performs the % operation. Read more

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

The resulting type after applying the % operator.

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

Performs the % operation. Read more

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

The resulting type after applying the << operator.

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

Performs the << operation. Read more

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

The resulting type after applying the << operator.

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

Performs the << operation. Read more

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

The resulting type after applying the >> operator.

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

Performs the >> operation. Read more

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

The resulting type after applying the >> operator.

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

Performs the >> operation. Read more

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

The resulting type after applying the - operator.

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

Performs the - operation. Read more

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

The resulting type after applying the - operator.

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

Performs the - operation. Read more

Auto Trait Implementations

Blanket Implementations

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

default fn to_string(&self) -> String

Converts the given value to a String. Read more

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.