Struct matfile::MatFile

source ·
pub struct MatFile { /* private fields */ }
Expand description

MatFile is a collection of named arrays.

You can load a “.mat” file from disk like this:

let file = std::fs::File::open("tests/double.mat")?;
let mat_file = matfile::MatFile::parse(file)?;

Implementations§

source§

impl MatFile

source

pub fn parse<R: Read>(reader: R) -> Result<Self, Error>

Tries to parse a byte sequence as a “.mat” file.

source

pub fn arrays(&self) -> &Vec<Array>

List of all arrays in this .mat file.

When parsing a .mat file all arrays of unsupported type (currently all non-numerical and sparse arrays) will be ignored and will thus not be part of this list.

source

pub fn find_by_name<'me>(&'me self, name: &str) -> Option<&'me Array>

Returns an array with the given name if it exists. Case sensitive.

When parsing a .mat file all arrays of unsupported type (currently all non-numerical and sparse arrays) will be ignored and will thus not be returned by this function.

Trait Implementations§

source§

impl Clone for MatFile

source§

fn clone(&self) -> MatFile

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for MatFile

source§

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

Formats the value using the given formatter. 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> 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> ToOwned for T
where T: Clone,

§

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

§

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

§

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.