extendr_api::prelude::io

Struct Npy

pub struct Npy<'a> {
    aligned_bytes: &'a [u8],
    nrows: usize,
    ncols: usize,
    prefix_len: usize,
    dtype: NpyDType,
    fortran_order: bool,
}
Expand description

Memory view over a buffer in npy format.

Fields§

§aligned_bytes: &'a [u8]§nrows: usize§ncols: usize§prefix_len: usize§dtype: NpyDType§fortran_order: bool

Implementations§

§

impl<'a> Npy<'a>

pub fn new(data: &'a [u8]) -> Result<Npy<'a>, Error>

Parse a npy file from a memory buffer.

pub fn dtype(&self) -> NpyDType

Returns the data type of the memory buffer.

pub fn is_aligned(&self) -> bool

Checks if the memory buffer is aligned, in which case the data can be referenced in-place.

pub fn as_aligned_ref<E>(&self) -> MatRef<'_, E>
where E: FromNpy,

If the memory buffer is aligned, and the provided type matches the one stored in the buffer, returns a matrix view over the data.

pub fn to_mat<E>(&self) -> Mat<E>
where E: FromNpy,

If the provided type matches the one stored in the buffer, returns a matrix containing the data.

Auto Trait Implementations§

§

impl<'a> Freeze for Npy<'a>

§

impl<'a> RefUnwindSafe for Npy<'a>

§

impl<'a> Send for Npy<'a>

§

impl<'a> Sync for Npy<'a>

§

impl<'a> Unpin for Npy<'a>

§

impl<'a> UnwindSafe for Npy<'a>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.