Enum Bounded

pub enum Bounded<T> {
    None,
    Single(T),
    Range {
        start: Option<T>,
        end: Option<T>,
    },
}

Variants

None

Single(T)

Range

Fields

start: Option<T>

end: Option<T>

Implementations

impl<T> Bounded<T>

pub const fn start_from(value: T) -> Self

pub const fn up_to(value: T) -> Self

pub const fn as_start(&self) -> Option<&T>

pub const fn as_end(&self) -> Option<&T>

pub const fn start_and_end(&self) -> (Option<&T>, Option<&T>)

pub const fn single_value(value: T) -> Self

impl<T: Default + Clone> Bounded<T>

pub fn as_minimum(&self) -> Option<&T>

pub fn minimum(&self) -> T

impl<T: WrappingSub<Output = T> + SaturatingAdd<Output = T> + From<u8>> Bounded<T>

pub fn range(&self) -> Option<T>

impl<T: Sub<Output = T> + Debug + Default + Clone + PartialOrd> Bounded<T>

pub fn effective_value(&self, value: T) -> Either<T, T>

Returns the effective value which is either the number, or the positive offset of that number from the start of the value range. Either::Left represents the positive offset, and Either::Right represents the number.

impl<T: Sub<Output = T> + Debug + Default + Clone + PartialOrd<T>> Bounded<T>

where Integer: From<T>,

pub fn effective_bigint_value(&self, value: Integer) -> Either<Integer, Integer>

The same as [effective_value] except using crate::types::Integer.

impl Bounded<i128>

pub fn bigint_contains(&self, element: &Integer) -> bool

impl<T: PartialEq + PartialOrd> Bounded<T>

pub fn new(start: T, end: T) -> Self

Creates a new range from start to end.

Panics

When start > end.

pub const fn const_new(start: T, end: T) -> Self

Const compatible range constructor.

Safety

Requires start <= end otherwise functions will return incorrect results.. In general you should prefer Self::new which has debug assertions to ensure this.

pub fn contains(&self, element: &T) -> bool

pub fn contains_or<E>(&self, element: &T, error: E) -> Result<(), E>

pub fn contains_or_else<E>( &self, element: &T, error: impl FnOnce() -> E, ) -> Result<(), E>

Trait Implementations

impl<T: Clone> Clone for Bounded<T>

fn clone(&self) -> Bounded<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Bounded<T>

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

Formats the value using the given formatter.

impl<T> Default for Bounded<T>

fn default() -> Bounded<T>

Returns the “default value” for a type.

impl<T: Display> Display for Bounded<T>

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

Formats the value using the given formatter.

impl From<Bounded<i128>> for Value

fn from(bounded: Bounded<i128>) -> Self

Converts to this type from the input type.

impl From<Bounded<i16>> for Value

fn from(bounded: Bounded<i16>) -> Self

Converts to this type from the input type.

impl From<Bounded<i32>> for Value

fn from(bounded: Bounded<i32>) -> Self

Converts to this type from the input type.

impl From<Bounded<i64>> for Value

fn from(bounded: Bounded<i64>) -> Self

Converts to this type from the input type.

impl From<Bounded<i8>> for Value

fn from(bounded: Bounded<i8>) -> Self

Converts to this type from the input type.

impl From<Bounded<u16>> for Value

fn from(bounded: Bounded<u16>) -> Self

Converts to this type from the input type.

impl From<Bounded<u32>> for Value

fn from(bounded: Bounded<u32>) -> Self

Converts to this type from the input type.

impl From<Bounded<u64>> for Value

fn from(bounded: Bounded<u64>) -> Self

Converts to this type from the input type.

impl From<Bounded<u8>> for Value

fn from(bounded: Bounded<u8>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Bounded<T>

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> Ord for Bounded<T>

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

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

fn partial_cmp(&self, other: &Bounded<T>) -> 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 TryFrom<Bounded<usize>> for Value

type Error = <i128 as TryFrom<usize>>::Error

The type returned in the event of a conversion error.

fn try_from(bounded: Bounded<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy> Copy for Bounded<T>

impl<T: Eq> Eq for Bounded<T>

impl<T> StructuralPartialEq for Bounded<T>