Skip to main content

ShdfFile

Struct ShdfFile 

Source
pub struct ShdfFile {
    pub datasets: Vec<Dataset>,
    pub global_attributes: Vec<(String, String)>,
}
Expand description

An in-memory .shdf file.

Fields§

§datasets: Vec<Dataset>

Ordered list of datasets.

§global_attributes: Vec<(String, String)>

File-level key/value string attributes.

Implementations§

Source§

impl ShdfFile

Source

pub fn new() -> Self

Create an empty ShdfFile.

Source

pub fn add_dataset_f64(&mut self, name: &str, shape: Vec<usize>, data: Vec<f64>)

Append a Float64 dataset.

Source

pub fn add_dataset_i32(&mut self, name: &str, shape: Vec<usize>, data: Vec<i32>)

Append an Int32 dataset.

Source

pub fn add_global_attr(&mut self, key: &str, value: &str)

Add a global (file-level) key/value attribute.

Source

pub fn get_f64(&self, name: &str) -> Option<&[f64]>

Look up a Float64 dataset by name and return its data slice.

Source

pub fn get_i32(&self, name: &str) -> Option<&[i32]>

Look up an Int32 dataset by name and return its data slice.

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize the file to a binary blob (little-endian).

Source

pub fn from_bytes(data: &[u8]) -> Result<Self, String>

Deserialize a binary blob written by ShdfFile::to_bytes.

Returns Err(String) on any format violation.

Source

pub fn write_to_text(&self) -> String

Return a human-readable summary of the file contents.

Trait Implementations§

Source§

impl Clone for ShdfFile

Source§

fn clone(&self) -> ShdfFile

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShdfFile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ShdfFile

Source§

fn default() -> Self

Returns the “default value” for a type. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.