Skip to main content

MemmapArray

Struct MemmapArray 

Source
pub struct MemmapArray<T: Element> { /* private fields */ }
Expand description

A read-only memory-mapped array backed by a .npy file.

The array data is mapped directly from the file. No copy is made. The data remains valid as long as this struct is alive.

Implementations§

Source§

impl<T: Element> MemmapArray<T>

Source

pub fn shape(&self) -> &[usize]

Return the shape of the mapped array.

Source

pub fn as_slice(&self) -> &[T]

Return the mapped data as a slice.

Source

pub fn to_array(&self) -> FerrayResult<Array<T, IxDyn>>

Copy the memory-mapped data into an owned Array.

Source

pub fn view(&self) -> ArrayView<'_, T, IxDyn>

Borrow the memory-mapped data as an ArrayView<T, IxDyn> so it can be passed directly to ferray functions that expect an &Array<_> or ArrayView<_> (#496). The view is C-contiguous row-major and lives as long as the underlying mmap.

Trait Implementations§

Auto Trait Implementations§

§

impl<T> Freeze for MemmapArray<T>

§

impl<T> RefUnwindSafe for MemmapArray<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for MemmapArray<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for MemmapArray<T>

§

impl<T> UnwindSafe for MemmapArray<T>

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> 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<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.