Skip to main content

NpzArchive

Struct NpzArchive 

Source
pub struct NpzArchive {
    pub arrays: Vec<(String, NpyArray)>,
}
Expand description

A higher-level NPZ archive that stores typed NpyArray objects by name.

Unlike NpzWriter, this type stores fully parsed NpyArray values and supports reading them back without specifying the dtype at call time.

Fields§

§arrays: Vec<(String, NpyArray)>

Named arrays stored in the archive.

Implementations§

Source§

impl NpzArchive

Source

pub fn new() -> Self

Create an empty archive.

Source

pub fn insert(&mut self, name: &str, array: NpyArray)

Add an NpyArray under the given name.

Source

pub fn get(&self, name: &str) -> Option<&NpyArray>

Retrieve a reference to the array with the given name.

Source

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

List all array names.

Source

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

Remove an array by name; returns true if it was present.

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 to_bytes(&self) -> Result<Vec<u8>, String>

Serialize to the NPZ container format (compatible with NpzWriter).

Source

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

Deserialize from NPZ container bytes.

Source§

impl NpzArchive

Source

pub fn add_array(&mut self, name: &str, array: NpyArray)

Add a pre-built NpyArray under name, replacing any existing entry with that name.

Source

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

Load all arrays from raw NPZ bytes and return them as a new archive.

This is an alias for NpzArchive::from_bytes with a more descriptive name to match the “load_all” specification.

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &NpyArray)>

Return an iterator over (name, &NpyArray) pairs.

Source

pub fn merge(&mut self, other: NpzArchive)

Merge another archive into self, overwriting duplicate names.

Source

pub fn total_elements(&self) -> usize

Return the total number of elements across all stored arrays.

Trait Implementations§

Source§

impl Clone for NpzArchive

Source§

fn clone(&self) -> NpzArchive

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 NpzArchive

Source§

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

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

impl Default for NpzArchive

Source§

fn default() -> NpzArchive

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.