Enum Extent 

pub enum Extent {
    Dims([u32; 3]),
    Ranges(RangeExtent),
}

The extent of the structured object being represented in 3D space.

Variants

Dims([u32; 3])

Legacy formats use dimensions to indicate the extent of a grid.

Ranges(RangeExtent)

In XML format, inclusive ranges are given as a 6-tuple:

[ x0 x1 y0 y1 z0 z1 ]

where the extent of the grid in say x is given by the inclusive range x0..=x1.

These are translated into Rust’s RangeInclusive for explicitness and convenience as

[ x0..=x1, y0..=y1, z0..=z1 ]

The equivalent extent in legacy format would be Dims([x1-x0+1, y1-y0+1, z1-z0+1]).

Implementations

impl Extent

pub fn into_dims(self) -> [u32; 3]

Convert Extent to a triple of dimensions.

If the extent is stored as Extent::Ranges such as

[ x0..=x1, y0..=y1, z0..=z1 ]

then the equivalent extent in legacy format is returned:

[x1-x0+1, y1-y0+1, z1-z0+1]

pub fn into_ranges(self) -> [RangeInclusive<i32>; 3]

Convert Extent to a triplet of ranges.

If the extent is stored as Extent::Dims such as

[ nx, ny, nz ]

then the equivalent extent in XML format is returned:

[0..=nx, 0..=ny, 0..=nz]

pub fn num_points(&self) -> u64

Compute the total number of points represented by this extent.

pub fn num_cells(&self) -> u64

Compute the total number of cells represented by this extent.

Trait Implementations

impl Clone for Extent

fn clone(&self) -> Extent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Extent

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

Formats the value using the given formatter.

impl Default for Extent

fn default() -> Extent

The default extent is empty.

impl From<Extent> for Extent

fn from(ext: Extent) -> Extent

Converts to this type from the input type.

impl From<Extent> for Extent

fn from(ext: Extent) -> Extent

Converts to this type from the input type.

impl PartialEq for Extent

fn eq(&self, other: &Extent) -> 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 StructuralPartialEq for Extent