Struct MessageType 

pub struct MessageType(/* private fields */);

Available on crate feature std only.

Identifies an HDF5 object header message type.

Every u16 is a valid MessageType, so an identifier that this crate does not recognize remains representable without losing its raw value. Recognized identifiers are exposed as associated constants such as Self::DATASPACE.

MessageType is carried by Error::MissingMessage. Its transparent representation gives it the same size, alignment, and ABI as u16.

The format specification calls the on-disk value the “Header Message Type” and defines its values in “Data Object Header Messages” of the format specification, version 4.0.

Implementations

impl MessageType

pub const NIL: Self

Identifies an object header message that the reader ignores.

pub const DATASPACE: Self

Identifies the dimensionality and extents of a dataset.

pub const LINK_INFO: Self

Identifies the storage and indexing information for a group’s links.

pub const DATATYPE: Self

Identifies the datatype of a dataset or committed datatype.

pub const FILL_VALUE_OLD: Self

Identifies a fill value encoded in the original fill-value message format.

pub const FILL_VALUE: Self

Identifies the value used to fill unwritten dataset elements.

pub const LINK: Self

Identifies a link stored in an object header.

pub const EXTERNAL_DATA_FILES: Self

Identifies dataset data stored in files outside the HDF5 file.

The message lists the external files and the portions of those files used for the dataset. This crate does not follow external files and rejects a dataset that uses them.

H5Pset_external configures this storage in the C library. The message is defined in “The Data Storage - External Data Files Message” of the format specification, version 4.0.

pub const DATA_LAYOUT: Self

Identifies how a dataset’s raw data is stored.

pub const GROUP_INFO: Self

Identifies storage parameters for a group.

pub const FILTER_PIPELINE: Self

Identifies the filter pipeline applied to a dataset’s raw data.

pub const ATTRIBUTE: Self

Identifies an attribute stored in an object header.

pub const SHARED_MESSAGE_TABLE: Self

Identifies the table used to locate shared object header messages.

pub const OBJECT_HEADER_CONTINUATION: Self

Identifies a block that contains additional object header messages.

pub const SYMBOL_TABLE: Self

Identifies the symbol-table storage used by an old-style group.

pub const OBJECT_MODIFICATION_TIME: Self

Identifies the last modification time of an object.

pub const B_TREE_K_VALUES: Self

Identifies non-default B-tree K values stored with an object.

pub const ATTRIBUTE_INFO: Self

Identifies the storage and indexing information for densely stored attributes.

pub const OBJECT_REFERENCE_COUNT: Self

Identifies the number of hard links that point to an object.

pub const FILE_SPACE_INFO: Self

Identifies the information used to manage free space in the file.

pub const fn is_known(self) -> bool

Returns whether this crate recognizes the message type.

Recognition means that the identifier has an associated constant and a symbolic name in this module. An identifier can be defined by the HDF5 specification without being recognized by this crate.

impl MessageType

pub const fn from_u16(value: u16) -> Self

Constructs a message type without interpreting the raw identifier.

Every u16 is accepted. Use Self::is_known or Self::unknown_id when the distinction between recognized and unrecognized identifiers matters.

pub const fn to_u16(self) -> u16

Returns the raw HDF5 message type identifier.

pub const fn is_unknown(self) -> bool

Returns whether this crate does not recognize the message type.

An unrecognized identifier can still be defined by the HDF5 specification. It has no associated symbolic name in this crate.

pub const fn unknown_id(self) -> Option<u16>

Returns the raw identifier when this crate does not recognize the message type.

Returns None when Self::is_known is true.

Trait Implementations

impl Clone for MessageType

fn clone(&self) -> MessageType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MessageType

impl Debug for MessageType

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

Formats the value using the given formatter.

impl Display for MessageType

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

Formats the value using the given formatter.

impl Eq for MessageType

impl From<MessageType> for u16

fn from(value: MessageType) -> Self

Converts to this type from the input type.

impl From<u16> for MessageType

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for MessageType

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 PartialEq for MessageType

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MessageType