Skip to main content

ExplicitCompoundTypeBuilder

Struct ExplicitCompoundTypeBuilder 

Source
pub struct ExplicitCompoundTypeBuilder { /* private fields */ }
Expand description

Builder for an HDF5 compound datatype with explicit field offsets and size.

This is the pure-Rust equivalent of creating an H5T_COMPOUND type and inserting fields with H5Tinsert. build validates field names, bounds, and overlap before returning a datatype.

Implementations§

Source§

impl ExplicitCompoundTypeBuilder

Source

pub fn field(self, name: &str, byte_offset: u64, datatype: Datatype) -> Self

Add a field at an explicit byte offset.

Source

pub fn f64_field(self, name: &str, byte_offset: u64) -> Self

Add an f64 field at an explicit byte offset.

Source

pub fn f32_field(self, name: &str, byte_offset: u64) -> Self

Add an f32 field at an explicit byte offset.

Source

pub fn i32_field(self, name: &str, byte_offset: u64) -> Self

Add an i32 field at an explicit byte offset.

Source

pub fn i64_field(self, name: &str, byte_offset: u64) -> Self

Add an i64 field at an explicit byte offset.

Source

pub fn u8_field(self, name: &str, byte_offset: u64) -> Self

Add a u8 field at an explicit byte offset.

Source

pub fn i8_field(self, name: &str, byte_offset: u64) -> Self

Add an i8 field at an explicit byte offset.

Source

pub fn i16_field(self, name: &str, byte_offset: u64) -> Self

Add an i16 field at an explicit byte offset.

Source

pub fn u16_field(self, name: &str, byte_offset: u64) -> Self

Add a u16 field at an explicit byte offset.

Source

pub fn u32_field(self, name: &str, byte_offset: u64) -> Self

Add a u32 field at an explicit byte offset.

Source

pub fn u64_field(self, name: &str, byte_offset: u64) -> Self

Add a u64 field at an explicit byte offset.

Source

pub fn build(self) -> Result<Datatype, FormatError>

Validate and build the compound datatype.

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