Struct Extent 

#[repr(transparent)]
pub struct Extent<T, const D: usize> {
    pub dim: [T; D],
}

📐 An orthogonal extension in D-space without a coordinate position.

---

^{📍geom/metric}

---

Represents the lengths of each dimension in a multi-dimensional space, providing an origin-agnostic shape with the implied form of an orthotope (generalized rectangle or box).

See also Extent1, Extent2, Extent3.

Fields

dim: [T; D]

The size values in D-dimensional space.

Implementations

impl<T, const D: usize> Extent<T, D>

pub const fn new(dimensions: [T; D]) -> Self

Constructs a new Extent from the given dimensions.

pub const fn as_slice(&self) -> &[T]

Returns a shared reference to the extent as a slice.

pub const fn as_slice_mut(&mut self) -> &mut [T]

Returns an exclusive reference to the extent as a slice.

pub fn is_uniform_nd(&self) -> bool

where T: PartialEq,

Returns true if all dimensions of the extent are equal. Returns true if all dimensions of the extent are equal.

impl<T> Extent<T, 2>

pub const fn x(self) -> T

where T: Copy,

Returns a copy of the first dimension x.

pub const fn y(self) -> T

where T: Copy,

Returns a copy of the second dimension y.

pub fn is_uniform(&self) -> bool

where T: PartialEq,

Returns true if the 2 dimensions are equal.

impl<T> Extent<T, 3>

pub const fn x(self) -> T

where T: Copy,

Returns a copy of the first dimension x.

pub const fn y(self) -> T

where T: Copy,

Returns a copy of the second dimension y.

pub const fn z(self) -> T

where T: Copy,

Returns a copy of the third dimension z.

pub fn is_uniform_3d(&self) -> bool

where T: PartialEq,

Returns true if the 3 dimensions are equal.

impl<const D: usize> Extent<i8, D>

pub const fn measure(self) -> i8

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> i8

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<i8, 2>

pub const fn area(self) -> i8

The area of the 2d extent.

pub const fn perimeter(self) -> i8

The perimeter of the 2d extent.

impl Extent<i8, 3>

pub const fn volume(self) -> i8

The volume of the 3d extent.

pub const fn surface_area(self) -> i8

The surface area of the 3d extent.

impl<const D: usize> Extent<i16, D>

pub const fn measure(self) -> i16

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> i16

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<i16, 2>

pub const fn area(self) -> i16

The area of the 2d extent.

pub const fn perimeter(self) -> i16

The perimeter of the 2d extent.

impl Extent<i16, 3>

pub const fn volume(self) -> i16

The volume of the 3d extent.

pub const fn surface_area(self) -> i16

The surface area of the 3d extent.

impl<const D: usize> Extent<i32, D>

pub const fn measure(self) -> i32

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> i32

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<i32, 2>

pub const fn area(self) -> i32

The area of the 2d extent.

pub const fn perimeter(self) -> i32

The perimeter of the 2d extent.

impl Extent<i32, 3>

pub const fn volume(self) -> i32

The volume of the 3d extent.

pub const fn surface_area(self) -> i32

The surface area of the 3d extent.

impl<const D: usize> Extent<i64, D>

pub const fn measure(self) -> i64

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> i64

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<i64, 2>

pub const fn area(self) -> i64

The area of the 2d extent.

pub const fn perimeter(self) -> i64

The perimeter of the 2d extent.

impl Extent<i64, 3>

pub const fn volume(self) -> i64

The volume of the 3d extent.

pub const fn surface_area(self) -> i64

The surface area of the 3d extent.

impl<const D: usize> Extent<i128, D>

pub const fn measure(self) -> i128

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> i128

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<i128, 2>

pub const fn area(self) -> i128

The area of the 2d extent.

pub const fn perimeter(self) -> i128

The perimeter of the 2d extent.

impl Extent<i128, 3>

pub const fn volume(self) -> i128

The volume of the 3d extent.

pub const fn surface_area(self) -> i128

The surface area of the 3d extent.

impl<const D: usize> Extent<isize, D>

pub const fn measure(self) -> isize

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> isize

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<isize, 2>

pub const fn area(self) -> isize

The area of the 2d extent.

pub const fn perimeter(self) -> isize

The perimeter of the 2d extent.

impl Extent<isize, 3>

pub const fn volume(self) -> isize

The volume of the 3d extent.

pub const fn surface_area(self) -> isize

The surface area of the 3d extent.

impl<const D: usize> Extent<u8, D>

pub const fn measure(self) -> u8

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> u8

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<u8, 2>

pub const fn area(self) -> u8

The area of the 2d extent.

pub const fn perimeter(self) -> u8

The perimeter of the 2d extent.

impl Extent<u8, 3>

pub const fn volume(self) -> u8

The volume of the 3d extent.

pub const fn surface_area(self) -> u8

The surface area of the 3d extent.

impl<const D: usize> Extent<u16, D>

pub const fn measure(self) -> u16

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> u16

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<u16, 2>

pub const fn area(self) -> u16

The area of the 2d extent.

pub const fn perimeter(self) -> u16

The perimeter of the 2d extent.

impl Extent<u16, 3>

pub const fn volume(self) -> u16

The volume of the 3d extent.

pub const fn surface_area(self) -> u16

The surface area of the 3d extent.

impl<const D: usize> Extent<u32, D>

pub const fn measure(self) -> u32

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> u32

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<u32, 2>

pub const fn area(self) -> u32

The area of the 2d extent.

pub const fn perimeter(self) -> u32

The perimeter of the 2d extent.

impl Extent<u32, 3>

pub const fn volume(self) -> u32

The volume of the 3d extent.

pub const fn surface_area(self) -> u32

The surface area of the 3d extent.

impl<const D: usize> Extent<u64, D>

pub const fn measure(self) -> u64

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> u64

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<u64, 2>

pub const fn area(self) -> u64

The area of the 2d extent.

pub const fn perimeter(self) -> u64

The perimeter of the 2d extent.

impl Extent<u64, 3>

pub const fn volume(self) -> u64

The volume of the 3d extent.

pub const fn surface_area(self) -> u64

The surface area of the 3d extent.

impl<const D: usize> Extent<u128, D>

pub const fn measure(self) -> u128

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> u128

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<u128, 2>

pub const fn area(self) -> u128

The area of the 2d extent.

pub const fn perimeter(self) -> u128

The perimeter of the 2d extent.

impl Extent<u128, 3>

pub const fn volume(self) -> u128

The volume of the 3d extent.

pub const fn surface_area(self) -> u128

The surface area of the 3d extent.

impl<const D: usize> Extent<usize, D>

pub const fn measure(self) -> usize

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> usize

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<usize, 2>

pub const fn area(self) -> usize

The area of the 2d extent.

pub const fn perimeter(self) -> usize

The perimeter of the 2d extent.

impl Extent<usize, 3>

pub const fn volume(self) -> usize

The volume of the 3d extent.

pub const fn surface_area(self) -> usize

The surface area of the 3d extent.

impl<const D: usize> Extent<f32, D>

pub const fn measure(self) -> f32

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> f32

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<f32, 2>

pub const fn area(self) -> f32

Returns the area of the 2d extent.

pub const fn perimeter(self) -> f32

Returns the perimeter of the 2d extent.

impl Extent<f32, 3>

pub const fn volume(self) -> f32

Returns the volume of the 3d extent.

pub const fn surface_area(self) -> f32

The surface area of the 3d extent.

impl<const D: usize> Extent<f64, D>

pub const fn measure(self) -> f64

Returns the internal measure, the product of the extents.

It’s equivalent to length, area, and volume in 1, 2 and 3 dimensions.

pub const fn boundary(self) -> f64

Returns the external boundary, the sum of the extents.

It’s equivalent to 2, perimeter and surface area in 1, 2 and 3 dimensions.

impl Extent<f64, 2>

pub const fn area(self) -> f64

Returns the area of the 2d extent.

pub const fn perimeter(self) -> f64

Returns the perimeter of the 2d extent.

impl Extent<f64, 3>

pub const fn volume(self) -> f64

Returns the volume of the 3d extent.

pub const fn surface_area(self) -> f64

The surface area of the 3d extent.

impl<T: Copy> Extent<T, 1>

1D accessors

pub const fn length(self) -> T

Returns a copy of the first dimension.

pub const fn l(self) -> T

Returns a copy of the first dimension.

impl<T: Copy> Extent<T, 2>

2D Accessors

pub const fn width(self) -> T

Returns a copy of the horizontal dimension (X-axis).

pub const fn w(self) -> T

Returns a copy of the horizontal dimension (X-axis).

pub const fn height(self) -> T

Returns a copy of the vertical dimension (Y-axis).

pub const fn h(self) -> T

Returns a copy of the vertical dimension (Y-axis).

pub const fn length(self) -> T

Returns a copy of the horizontal dimension (X-axis) (width).

pub const fn l(self) -> T

Returns a copy of the horizontal dimension (X-axis) (width).

pub const fn breadth(self) -> T

Returns a copy of the vertical dimension (Y-axis) (width).

pub const fn b(self) -> T

Returns a copy of the vertical dimension (Y-axis) (width).

impl<T: Copy> Extent<T, 3>

3D Accessors

pub const fn width(self) -> T

Returns a copy of the horizontal dimension (X-axis) (width).

pub const fn w(self) -> T

Returns a copy of the horizontal dimension (X-axis) (width).

pub const fn height(self) -> T

Returns a copy of the vertical dimension (Y-axis).

pub const fn h(self) -> T

Returns a copy of the vertical dimension (Y-axis).

pub const fn depth(self) -> T

Returns a copy of the depth dimension (Z-axis).

pub const fn d(self) -> T

Returns a copy of the depth dimension (Z-axis).

Trait Implementations

impl<T: Clone, const D: usize> Clone for Extent<T, D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ConstInitCore, const D: usize> ConstInitCore for Extent<T, D>

const INIT: Self

Returns the compile-time “initial value” for a type.

impl<T: Copy, const D: usize> Copy for Extent<T, D>

impl<T: Debug, const D: usize> Debug for Extent<T, D>

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

Formats the value using the given formatter.

impl<T: Default, const D: usize> Default for Extent<T, D>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display, const D: usize> Display for Extent<T, D>

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

Formats the value using the given formatter.

impl<T: Eq, const D: usize> Eq for Extent<T, D>

impl<T> From<(T, T)> for Extent<T, 2>

fn from(dim: (T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T)> for Extent<T, 3>

fn from(dim: (T, T, T)) -> Self

Converts to this type from the input type.

impl<T> From<(T, T, T, T)> for Extent<T, 4>

fn from(dim: (T, T, T, T)) -> Self

Converts to this type from the input type.

impl<T, const D: usize> From<[T; D]> for Extent<T, D>

fn from(dim: [T; D]) -> Self

Converts to this type from the input type.

impl<T: Hash, const D: usize> Hash for Extent<T, D>

fn hash<HR: Hasher>(&self, state: &mut HR)

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, const D: usize> Ord for Extent<T, D>

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: PartialEq, const D: usize> PartialEq for Extent<T, D>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd, const D: usize> PartialOrd for Extent<T, D>

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