Struct Extent

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

Implementations

impl<N: PrimInt> Extent<N>

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

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

pub unsafe fn lo_unchecked(&self) -> N

pub unsafe fn hi_unchecked(&self) -> N

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).

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.

pub fn empty() -> Self

pub fn is_empty(&self) -> bool

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

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

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

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

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

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

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

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

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

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

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

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