Skip to main content

Attribute

Struct Attribute 

Source
pub struct Attribute {
    pub name: String,
    pub datatype: Datatype,
    pub shape: Vec<u64>,
    pub raw_data: Vec<u8>,
}
Expand description

A parsed, high-level HDF5 attribute.

Fields§

§name: String§datatype: Datatype§shape: Vec<u64>§raw_data: Vec<u8>

Implementations§

Source§

impl Attribute

Source

pub fn from_message(msg: AttributeMessage) -> Self

Create from a parsed attribute message.

Source

pub fn from_message_with_context( msg: AttributeMessage, file_data: Option<&[u8]>, offset_size: u8, ) -> Self

Create from a parsed attribute message with optional file context for resolving variable-length byte attributes stored in the global heap.

Source

pub fn num_elements(&self) -> u64

Total number of elements.

Source

pub fn read_scalar<T: H5Type>(&self) -> Result<T>

Read the attribute value as a scalar of the given type.

Source

pub fn read_1d<T: H5Type>(&self) -> Result<Vec<T>>

Read the attribute as a 1-D vector of the given type.

Source

pub fn read_string(&self) -> Result<String>

Read the attribute as a string (for string-typed attributes).

For variable-length strings, use read_vlen_string() with the file data and offset_size — this method will return an error directing you there.

Source

pub fn read_vlen_string( &self, file_data: &[u8], offset_size: u8, ) -> Result<String>

Read a variable-length string attribute from the global heap.

Variable-length strings in HDF5 are stored as references into a global heap collection. Each reference is: seq_len(u32) + heap_addr(offset_size) + index(u32).

Source

pub fn read_vlen_strings( &self, file_data: &[u8], offset_size: u8, ) -> Result<Vec<String>>

Read an array of variable-length strings from the global heap.

Source

pub fn read_strings(&self) -> Result<Vec<String>>

Read the attribute as a vector of strings.

Source

pub fn read_as_f64(&self) -> Result<f64>

Read an attribute as f64 (with automatic promotion from int types).

Trait Implementations§

Source§

impl Clone for Attribute

Source§

fn clone(&self) -> Attribute

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Attribute

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.