Skip to main content

CompoundType

Struct CompoundType 

Source
pub struct CompoundType {
    pub members: Vec<(String, DatatypeMessage, u32)>,
    pub total_size: u32,
}
Expand description

A description of a compound (struct) type for use with HDF5 datasets.

Users can build compound types manually to describe structured data.

§Example

use rust_hdf5::types::CompoundType;
use rust_hdf5::format::messages::datatype::{DatatypeMessage, CompoundMember};

let ct = CompoundType {
    members: vec![
        ("x".to_string(), DatatypeMessage::f32_type(), 0),
        ("y".to_string(), DatatypeMessage::f32_type(), 4),
    ],
    total_size: 8,
};
let dt = ct.to_datatype();
assert_eq!(dt.element_size(), 8);

Fields§

§members: Vec<(String, DatatypeMessage, u32)>

Members: (name, datatype, byte_offset).

§total_size: u32

Total size of the compound element in bytes.

Implementations§

Source§

impl CompoundType

Source

pub fn to_datatype(&self) -> DatatypeMessage

Convert this compound type description to a DatatypeMessage.

Trait Implementations§

Source§

impl Clone for CompoundType

Source§

fn clone(&self) -> CompoundType

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 CompoundType

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> 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.