Skip to main content

NpzWriter

Struct NpzWriter 

Source
pub struct NpzWriter {
    pub files: Vec<(String, Vec<u8>)>,
}
Expand description

Writer for the simplified .npz container format.

Each array is stored as a raw .npy blob. The container layout is:

[count: u32 LE]
foreach:
  [name_len: u32 LE][name UTF-8 bytes]
  [npy_len: u32 LE][npy bytes]

Fields§

§files: Vec<(String, Vec<u8>)>

Stored (name, npy_bytes) pairs.

Implementations§

Source§

impl NpzWriter

Source

pub fn new() -> Self

Create an empty NpzWriter.

Source

pub fn add_array_f64(&mut self, name: &str, shape: &[usize], data: &[f64])

Append a f64 array under name.

Source

pub fn add_array_f32(&mut self, name: &str, shape: &[usize], data: &[f32])

Append an f32 array under name.

Source

pub fn add_array_i32(&mut self, name: &str, shape: &[usize], data: &[i32])

Append an i32 array under name.

Source

pub fn add_array_i64(&mut self, name: &str, shape: &[usize], data: &[i64])

Append an i64 array under name.

Source

pub fn len(&self) -> usize

Number of arrays stored.

Source

pub fn is_empty(&self) -> bool

Whether the archive is empty.

Source

pub fn names(&self) -> Vec<&str>

List all array names.

Source

pub fn contains(&self, name: &str) -> bool

Check if an array with the given name exists.

Source

pub fn remove(&mut self, name: &str) -> bool

Remove an array by name. Returns true if found and removed.

Source

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

Serialize all stored arrays to bytes.

Source

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

Deserialize from bytes produced by NpzWriter::to_bytes.

Source

pub fn get_f64( &self, name: &str, ) -> Option<Result<(Vec<usize>, Vec<f64>), String>>

Retrieve a f64 array by name, returning (shape, data).

Source

pub fn get_f32( &self, name: &str, ) -> Option<Result<(Vec<usize>, Vec<f32>), String>>

Retrieve an f32 array by name, returning (shape, data).

Source

pub fn get_i32( &self, name: &str, ) -> Option<Result<(Vec<usize>, Vec<i32>), String>>

Retrieve an i32 array by name, returning (shape, data).

Source

pub fn get_i64( &self, name: &str, ) -> Option<Result<(Vec<usize>, Vec<i64>), String>>

Retrieve an i64 array by name, returning (shape, data).

Trait Implementations§

Source§

impl Clone for NpzWriter

Source§

fn clone(&self) -> NpzWriter

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 NpzWriter

Source§

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

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

impl Default for NpzWriter

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.