Enum Bounds

pub enum Bounds<T>
where
    T: Ord,
{
    Empty,
    Bounded(BoundsInner<T>),
    Sharp(BoundsInner<T>),
}

Minimum and maximum values (inclusive) of a collection of data, with some other variants for edge cases.

Variants

Empty

The source collection is empty so has no bounds.

Bounded(BoundsInner<T>)

After some operation (like Bounds::difference), the bounds cannot be determined exactly.

Instead, this variant underestimates the minimum and overestimates the maximum.

Sharp(BoundsInner<T>)

The exact bounds of the values of the source collection (inclusive).

Implementations

impl<T> Bounds<T>

where T: Ord,

pub fn sharp(min: T, max: T) -> Result<Self, NegativeBounds>

Construct a new Bounds::Sharp.

Returns an error if min > max.

pub fn bounded(min: T, max: T) -> Result<Self, NegativeBounds>

Construct a new Bounds::bounded.

Returns an error if min > max.

pub fn surrounds(&self, value: &T) -> bool

Returns true if the value is within these bounds.

This doesn’t necessarily mean that the source collection contains this value. However, a false result implies that the source collection cannot contain this value.

Trait Implementations

impl<T> Clone for Bounds<T>

where T: Ord + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Bounds<T>

where T: Ord + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Bounds<T>

where T: Ord,

fn default() -> Bounds<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Bounds<T>

where T: Ord + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> FromIterator<&'a T> for Bounds<T>

where T: Ord + Copy + 'a,

fn from_iter<I: IntoIterator<Item = &'a T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T> PartialEq for Bounds<T>

where T: Ord + PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

const 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> Serialize for Bounds<T>

where T: Ord + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for Bounds<T>

where T: Ord + Copy,

impl<T> Eq for Bounds<T>

where T: Ord + Eq,

impl<T> StructuralPartialEq for Bounds<T>

where T: Ord,