Struct IntervalLimit

Source
pub struct IntervalLimit<T: Display + Clone + Hash + Ord> { /* private fields */ }
Expand description

A struct that represents a “limit” in an interval.

In order to understand this struct, it is important to correctly recognize the distinction between limit and value. The limit is the value represented by this struct self, and the value represented by value is the limit value.

When a limit is “closed”, it means that the limit itself is not considered to be exceeded. An “open” limit means that it is considered to be exceeded.

An infinite limit is an unbounded limit, and we express this state by saying that value is Limitless. Infinite limits are always considered to be open. Conversely, a limit that is not an infinite limit (one whose value is not Limitless) is called a finite limit.

The lower limit represents the limit where values below (or below) the limit are considered to be exceeded, and the upper limit represents the limit where values above (or above) the limit are considered to be exceeded.

closed: if the limit is closed true lower: truefor the lower limit,false` for the upper limit value: limit value, in the case of Limitless, it indicates that there is no limit.

Implementations§

Source§

impl<T: Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> IntervalLimit<T>

Source

pub fn is_closed(&self) -> bool

Verify whether this limit is closed or not.

  • return: if it is closed, true, otherwise false.
Source

pub fn is_open(&self) -> bool

Verify whether this limit is open or not.

  • return: if it is open, true, otherwise false.
Source

pub fn is_lower(&self) -> bool

Verify whether or not this limit is the lower side limit.

  • return: true for an lower limit, false otherwise
Source

pub fn is_upper(&self) -> bool

Verify whether or not this limit is the upper side limit.

  • return: true for an upper limit, false otherwise
Source

pub fn is_infinity(&self) -> bool

Verify whether this limit is an infinite limit.

  • return: if it is an infinite limit, it is true, otherwise it is `false
Source

pub fn is_finite(&self) -> bool

Verify whether this limit is an finite limit.

  • return: if it is an finite limit, it is true, otherwise it is `false
Source

pub fn as_value(&self) -> &LimitValue<T>

Get limit value.

  • return: limit value
Source

pub fn new(closed: bool, lower: bool, value: LimitValue<T>) -> Self

Generate a limit

  • params
    • closed: if the limit is closed `true
    • lower: true for the lower limit, false for the upper limit
    • value: limit value, in the case of Limitless, it indicates that there is no limit.
  • return: a new limit
Source

pub fn lower(closed: bool, value: LimitValue<T>) -> Self

Generate a lower limit

  • params
    • closed: if the limit is closed `true
    • value: limit value, in the case of Limitless, it indicates that there is no limit.
  • return: a new limit
Source

pub fn upper(closed: bool, value: LimitValue<T>) -> Self

Generate a upper limit

  • params
    • closed: if the limit is closed `true
    • value: limit value, in the case of Limitless, it indicates that there is no limit.
  • return: a new limit

Trait Implementations§

Source§

impl<T: Clone + Display + Clone + Hash + Ord> Clone for IntervalLimit<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Display + Clone + Hash + Ord> Debug for IntervalLimit<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> Display for IntervalLimit<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Hash + Display + Clone + Hash + Ord> Hash for IntervalLimit<T>

Source§

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, Self: Sized,

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

impl<T: Ord + Display + Clone + Hash + Ord> Ord for IntervalLimit<T>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> PartialEq for IntervalLimit<T>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Display + Clone + Hash + Eq + Ord + PartialEq + PartialOrd> PartialOrd for IntervalLimit<T>

Source§

fn partial_cmp(&self, other: &Self) -> 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

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

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

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Eq + Display + Clone + Hash + Ord> Eq for IntervalLimit<T>

Auto Trait Implementations§

§

impl<T> Freeze for IntervalLimit<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for IntervalLimit<T>
where T: RefUnwindSafe,

§

impl<T> Send for IntervalLimit<T>
where T: Send,

§

impl<T> Sync for IntervalLimit<T>
where T: Sync,

§

impl<T> Unpin for IntervalLimit<T>
where T: Unpin,

§

impl<T> UnwindSafe for IntervalLimit<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.