Enum hdf5::Extents

pub enum Extents {
    Null,
    Scalar,
    Simple(SimpleExtents),
}

Variants

Null

A null dataspace contains no data elements.

Note that no selections can be applied to a null dataset as there is nothing to select.

Scalar

A scalar dataspace, representing just one element.

The datatype of this one element may be very complex, e.g., a compound structure with members being of any allowed HDF5 datatype, including multidimensional arrays, strings, and nested compound structures. By convention, the rank of a scalar dataspace is always 0 (zero); it may be thought of as a single, dimensionless point, though that point may be complex.

Simple(SimpleExtents)

Tuple Fields

0: SimpleExtents

A simple dataspace, a multidimensional array of elements.

The dimensionality of the dataspace (or the rank of the array) is fixed and is defined at creation time. The size of each dimension can grow during the life time of the dataspace from the current size up to the maximum size. Both the current size and the maximum size are specified at creation time. The sizes of dimensions at any particular time in the life of a dataspace are called the current dimensions, or the dataspace extent. They can be queried along with the maximum sizes.

A dimension can have an UNLIMITED maximum size. This results in a dataset which can be resized after being created. Do note that an unlimited dimension will force chunking of the dataset which could result in excessive disk usage with the default chunk size. It is recommended to apply some compression filter to such datasets.

Implementations

impl Extents

pub fn new<T: Into<Self>>(extents: T) -> Self

pub fn null() -> Self

Creates extents for a null dataspace.

pub fn scalar() -> Self

Creates extents for a scalar dataspace.

pub fn simple<T: Into<SimpleExtents>>(extents: T) -> Self

Creates extents for a simple dataspace.

pub fn is_null(&self) -> bool

Returns true if the extents type is null.

pub fn is_scalar(&self) -> bool

Returns true if the extents type is scalar.

pub fn is_simple(&self) -> bool

Returns true if the extents type is simple.

pub fn ndim(&self) -> usize

Returns the dataspace rank (or zero for null/scalar extents).

pub fn dims(&self) -> Vec<usize>

Returns the current extents (or empty list for null/scalar extents).

pub fn maxdims(&self) -> Vec<Option<usize>>

Returns the maximum extents (or empty list for null/scalar extents).

pub fn size(&self) -> usize

Returns the total number of elements.

pub fn is_valid(&self) -> bool

pub fn is_unlimited(&self) -> bool

pub fn is_resizable(&self) -> bool

pub fn resizable(self) -> Self

pub fn iter(
    &self
) -> impl ExactSizeIterator<Item = &Extent> + DoubleEndedIterator<Item = &Extent>

pub fn slice(&self) -> Option<&[Extent]>

Trait Implementations

impl Clone for Extents

fn clone(&self) -> Extents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extents

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

Formats the value using the given formatter.

impl Display for Extents

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

Formats the value using the given formatter.

impl From<&'_ Extents> for Extents

fn from(extents: &Self) -> Self

Performs the conversion.

impl From<()> for Extents

fn from(_: ()) -> Self

Performs the conversion.

impl<T: Into<SimpleExtents>> From<T> for Extents

fn from(extents: T) -> Self

Performs the conversion.

impl PartialEq<Extents> for Extents

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Extents

impl StructuralEq for Extents

impl StructuralPartialEq for Extents