Struct NpzReader

pub struct NpzReader<R: Read + Seek> { /* private fields */ }

Reader for .npz files.

Example

use ndarray::{Array1, Array2};
use ndarray_npy::NpzReader;
use std::fs::File;

let mut npz = NpzReader::new(File::open("arrays.npz")?)?;
let a: Array2<i32> = npz.by_name("a")?;
let b: Array1<i32> = npz.by_name("b")?;

Implementations

impl<R: Read + Seek> NpzReader<R>

pub fn new(reader: R) -> Result<NpzReader<R>, ReadNpzError>

Creates a new .npz file reader.

pub fn is_empty(&self) -> bool

Returns true iff the .npz file doesn’t contain any arrays.

pub fn len(&self) -> usize

Returns the number of arrays in the .npz file.

pub fn names(&mut self) -> Result<Vec<String>, ReadNpzError>

Returns the names of all of the arrays in the file.

Note that a single “.npy” suffix (if present) will be stripped from each name; this matches NumPy’s behavior.

pub fn by_name<S, D>( &mut self, name: &str, ) -> Result<ArrayBase<S, D>, ReadNpzError>

where S::Elem: ReadableElement, S: DataOwned, D: Dimension,

Reads an array by name.

Note that this first checks for name in the .npz file, and if that is not present, checks for format!("{name}.npy"). This matches NumPy’s behavior.

pub fn by_index<S, D>( &mut self, index: usize, ) -> Result<ArrayBase<S, D>, ReadNpzError>

where S::Elem: ReadableElement, S: DataOwned, D: Dimension,

Reads an array by index in the .npz file.