Type Alias Extent3d

pub type Extent3d<T> = Extent<T, 3>;

A 3-dimensional Extent.

Aliased Type

struct Extent3d<T> {
    pub size: [T; 3],
}

Fields

size: [T; 3]

The D-dimensional size.

Implementations

impl<T> Extent3d<T>

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 const fn x_ref(&self) -> &T

Returns a shared reference to the first dimension x.

pub const fn y_ref(&self) -> &T

Returns a shared reference to the second dimension y.

pub const fn z_ref(&self) -> &T

Returns a shared reference to the third dimension z.

pub fn x_mut(&mut self) -> &mut T

Returns an exclusive reference to the first dimension x.

pub fn y_mut(&mut self) -> &mut T

Returns an exclusive reference to the second dimension y.

pub fn z_mut(&mut self) -> &mut T

Returns an exclusive reference to the third dimension z.

pub fn is_uniform_3d(&self) -> bool

where T: PartialEq,

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

impl Extent3d<i8>

pub const fn c_volume(self) -> i8

The volume of the 3d extent.

pub const fn c_surface_area(self) -> i8

The surface area of the 3d extent.

impl Extent3d<i16>

pub const fn c_volume(self) -> i16

The volume of the 3d extent.

pub const fn c_surface_area(self) -> i16

The surface area of the 3d extent.

impl Extent3d<i32>

pub const fn c_volume(self) -> i32

The volume of the 3d extent.

pub const fn c_surface_area(self) -> i32

The surface area of the 3d extent.

impl Extent3d<i64>

pub const fn c_volume(self) -> i64

The volume of the 3d extent.

pub const fn c_surface_area(self) -> i64

The surface area of the 3d extent.

impl Extent3d<i128>

pub const fn c_volume(self) -> i128

The volume of the 3d extent.

pub const fn c_surface_area(self) -> i128

The surface area of the 3d extent.

impl Extent3d<isize>

pub const fn c_volume(self) -> isize

The volume of the 3d extent.

pub const fn c_surface_area(self) -> isize

The surface area of the 3d extent.

impl Extent3d<u8>

pub const fn c_volume(self) -> u8

The volume of the 3d extent.

pub const fn c_surface_area(self) -> u8

The surface area of the 3d extent.

impl Extent3d<u16>

pub const fn c_volume(self) -> u16

The volume of the 3d extent.

pub const fn c_surface_area(self) -> u16

The surface area of the 3d extent.

impl Extent3d<u32>

pub const fn c_volume(self) -> u32

The volume of the 3d extent.

pub const fn c_surface_area(self) -> u32

The surface area of the 3d extent.

impl Extent3d<u64>

pub const fn c_volume(self) -> u64

The volume of the 3d extent.

pub const fn c_surface_area(self) -> u64

The surface area of the 3d extent.

impl Extent3d<u128>

pub const fn c_volume(self) -> u128

The volume of the 3d extent.

pub const fn c_surface_area(self) -> u128

The surface area of the 3d extent.

impl Extent3d<usize>

pub const fn c_volume(self) -> usize

The volume of the 3d extent.

pub const fn c_surface_area(self) -> usize

The surface area of the 3d extent.

impl Extent3d<f32>

pub const fn volume(self) -> f32

The volume of the 3d extent.

pub const fn surface_area(self) -> f32

The surface area of the 3d extent.

impl Extent3d<f64>

pub const fn volume(self) -> f64

The volume of the 3d extent.

pub const fn surface_area(self) -> f64

The surface area of the 3d extent.

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

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

Interval-related methods

pub fn as_intervals(self) -> [Interval<T>; D]

where T: Default,

TODO

pub const fn as_intervals_const(self) -> [Interval<T>; D]

where T: Copy + ConstDefault,

TODO

pub fn to_intervals(&self) -> [Interval<T>; D]

where T: Clone + Default,

Converts each dimension into an interval from zero to the dimension’s extent.

pub fn fits_within(&self, interval: &Interval<T>) -> bool

where T: PartialOrd,

Checks if each dimension of the extent is within the given interval.

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<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<const D: usize> Extent<i128, D>

pub const fn c_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 c_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<const D: usize> Extent<i16, D>

pub const fn c_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 c_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<const D: usize> Extent<i32, D>

pub const fn c_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 c_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<const D: usize> Extent<i64, D>

pub const fn c_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 c_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<const D: usize> Extent<i8, D>

pub const fn c_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 c_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<const D: usize> Extent<isize, D>

pub const fn c_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 c_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<const D: usize> Extent<u128, D>

pub const fn c_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 c_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<const D: usize> Extent<u16, D>

pub const fn c_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 c_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<const D: usize> Extent<u32, D>

pub const fn c_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 c_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<const D: usize> Extent<u64, D>

pub const fn c_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 c_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<const D: usize> Extent<u8, D>

pub const fn c_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 c_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<const D: usize> Extent<usize, D>

pub const fn c_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 c_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.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

const DEFAULT: Self

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

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

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

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<'_>) -> Result

Formats the value using the given formatter.

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.

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

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

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

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