Struct Extent

Source
pub struct Extent<N: PrimInt> { /* private fields */ }

Implementations§

Source§

impl<N: PrimInt> Extent<N>

Source

pub fn lo(&self) -> Option<N>

Source

pub fn hi(&self) -> Option<N>

Source

pub unsafe fn lo_unchecked(&self) -> N

Source

pub unsafe fn hi_unchecked(&self) -> N

Source

pub fn len(&self) -> Option<usize>

Returns the number of values included in this extent, as a usize, if the elements of the extent and the quantity of values between them, inclusively, can all be represented exactly as a usize. Various conditions may make this impossible: if the extent uses a numeric type larger than a usize, for example, or even if it includes the entire range of possible usize values (the quantity of which are a number one greater than the largest representable usize). This function also returns None for any extents involving negatve values of signed types (some such cases could still be represented as usize differences from lo-to-hi, but it is fussy to get the cases all right and this is not the main use-case for this library).

Source

pub fn len_u64(&self) -> Option<u64>

Same as len() but targeting u64 rather than usize. Depending on use-case, some contexts prefer measuring extents against a definite-sized type.

Source

pub fn empty() -> Self

Source

pub fn is_empty(&self) -> bool

Source

pub fn new<T: Borrow<N>, U: Borrow<N>>(lo: T, hi: U) -> Self

Source

pub unsafe fn new_unchecked<T: Borrow<N>, U: Borrow<N>>(lo: T, hi: U) -> Self

Source

pub fn union<S: Borrow<Self>>(&self, other: S) -> Self

Source

pub fn intersect<S: Borrow<Self>>(&self, other: S) -> Self

Source

pub fn contains<T: Borrow<N>>(&self, n: T) -> bool

Source

pub fn iter(&self) -> ExtentIter<N>

Trait Implementations§

Source§

impl<N: Clone + PrimInt> Clone for Extent<N>

Source§

fn clone(&self) -> Extent<N>

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

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

Performs copy-assignment from source. Read more
Source§

impl<N: Debug + PrimInt> Debug for Extent<N>

Source§

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

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

impl<N: PrimInt> Default for Extent<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<N: PrimInt> From<Extent<N>> for RangeInclusive<N>

Source§

fn from(e: Extent<N>) -> Self

Converts to this type from the input type.
Source§

impl<N: PrimInt> From<Range<N>> for Extent<N>

Source§

fn from(r: Range<N>) -> Self

Converts to this type from the input type.
Source§

impl<N: PrimInt> From<RangeInclusive<N>> for Extent<N>

Source§

fn from(r: RangeInclusive<N>) -> Self

Converts to this type from the input type.
Source§

impl<N: Hash + PrimInt> Hash for Extent<N>

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<N: Ord + PrimInt> Ord for Extent<N>

Source§

fn cmp(&self, other: &Extent<N>) -> 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<N: PartialEq + PrimInt> PartialEq for Extent<N>

Source§

fn eq(&self, other: &Extent<N>) -> 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<N: PartialOrd + PrimInt> PartialOrd for Extent<N>

Source§

fn partial_cmp(&self, other: &Extent<N>) -> 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<N: PrimInt> TryFrom<Extent<N>> for Range<N>

Source§

type Error = &'static str

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

fn try_from(e: Extent<N>) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<N: Copy + PrimInt> Copy for Extent<N>

Source§

impl<N: Eq + PrimInt> Eq for Extent<N>

Source§

impl<N: PrimInt> StructuralPartialEq for Extent<N>

Auto Trait Implementations§

§

impl<N> Freeze for Extent<N>
where N: Freeze,

§

impl<N> RefUnwindSafe for Extent<N>
where N: RefUnwindSafe,

§

impl<N> Send for Extent<N>
where N: Send,

§

impl<N> Sync for Extent<N>
where N: Sync,

§

impl<N> Unpin for Extent<N>
where N: Unpin,

§

impl<N> UnwindSafe for Extent<N>
where N: 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, 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.