Struct MatFile 

pub struct MatFile { /* private fields */ }

MAT-file container

Stores MAT-file variables using a variable name as unique key.

Implementations

impl MatFile

pub fn new() -> Self

Create empty MatFile.

pub fn insert(&mut self, name: &str, value: MatVariable)

Insert a MatVariable called name.

A valid MATLAB variable

• has a length between 1 and 64 characters,
• starts with a ascii alphabetic character,
• contains only ascii alpha-numeric or underscore characters,
• does not match any reserved keyword.

See also here.

Panics

Panics, if name does not meet the criteria for a valid MATLAB variable name.

pub fn take(&mut self, name: &str) -> Option<MatVariable>

Take variable out of container.

Returns MatVariable stored under name. If not existing, returns None.

pub fn contains(&self, name: &str) -> bool

Return if variable name exists.

pub fn iter(&self) -> Iter<'_, String, MatVariable>

Return iterator over variables.

pub fn iter_mut(&mut self) -> IterMut<'_, String, MatVariable>

Return mutable iterator over variables.

Trait Implementations

impl Debug for MatFile

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

Formats the value using the given formatter.

impl Default for MatFile

fn default() -> Self

Returns the “default value” for a type.

impl Index<&str> for MatFile

type Output = MatVariable

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoIterator for MatFile

type Item = (String, MatVariable)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, MatVariable>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.