Enum MaxExtent 

pub enum MaxExtent {
    Fixed(u64),
    Unlimited,
}

The maximum size of one dimension of a dataspace.

A dataspace message stores a maximum size for each dimension, and the special “unlimited size” marks a dimension the data may expand along indefinitely. The maximum sizes are defined in “The Dataspace Message” of the format specification, version 4.0. The C library calls the unlimited size H5S_UNLIMITED.

Examples

use hdf5_pure::MaxExtent;

// A dataset that grows along its first dimension and keeps three columns.
let maxshape = [MaxExtent::Unlimited, MaxExtent::Fixed(3)];
assert_eq!(maxshape[0].size(), None);
assert_eq!(maxshape[1].size(), Some(3));

Variants

Fixed(u64)

The dimension grows to this many elements and no further.

Unlimited

The dimension grows without bound.

Implementations

impl MaxExtent

pub const fn size(self) -> Option<u64>

Returns the number of elements the dimension reaches at most, or None for a dimension that grows without bound.

Trait Implementations

impl Clone for MaxExtent

fn clone(&self) -> MaxExtent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaxExtent

impl Debug for MaxExtent

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

Formats the value using the given formatter.

impl Eq for MaxExtent

impl Hash for MaxExtent

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 Ord for MaxExtent

fn cmp(&self, other: &MaxExtent) -> 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 PartialEq for MaxExtent

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MaxExtent

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