Struct ndarray_npz::NpzReader

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

Reader for .npz files.

Example

use ndarray_npz::{
	ndarray::{Array1, Array2},
	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§

source§

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

source

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

Creates a new .npz file reader.

Errors

Reading a zip archive can fail with ZipError.

source

pub fn is_empty(&self) -> bool

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

source

pub fn len(&self) -> usize

Returns the number of arrays in the .npz file.

source

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

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

Errors

Reading a zip archive can fail with ZipError.

source

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.

Errors

Reading an array from an archive can fail with ReadNpyError or ZipError.

source

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.

Errors

Reading an array from an archive can fail with ReadNpyError or ZipError.

Auto Trait Implementations§

§

impl<R> RefUnwindSafe for NpzReader<R>where R: RefUnwindSafe,

§

impl<R> Send for NpzReader<R>where R: Send,

§

impl<R> Sync for NpzReader<R>where R: Sync,

§

impl<R> Unpin for NpzReader<R>where R: Unpin,

§

impl<R> UnwindSafe for NpzReader<R>where R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.