Struct MxArray 

pub struct MxArray(/* private fields */);

The owned variant of an mxArray. Some of Matlab’s mex functions specify that the caller is responsible for deallocating the object when it is done with it, unless the object in question is returned to Matlab. This cannot be expressed with just (mutable) references, so this type implements the owned type.

It is basically a wrapper around a mutable reference to an mxArray, but it implements the drop trait, so when it is dropped it calls mxDestroyArray. It implements Deref and DerefMut, so it can also be used where-ever a (mutable) reference to an mxArray is expected.

Implementations

impl MxArray

pub unsafe fn assume_responsibility(mx: &'static mut mxArray_tag) -> MxArray

Create an MxArray by assuming responsibility for freeing an mxArray. Unless you have allocated an mxArray yourself, you do not need this.

pub unsafe fn assume_responsibility_ptr(mx: *mut mxArray_tag) -> MxArray

See MxArray::assume_responsibility.

pub unsafe fn transfer_responsibility(o: MxArray) -> &'static mut mxArray_tag

Transfer responsibility for deallocating this mxArray back to Matlab. Unless you are manually calling raw matlab functions, you do not need this.

pub unsafe fn transfer_responsibility_ptr(o: MxArray) -> *mut mxArray_tag

See MxArray::transfer_responsibility.

Methods from Deref<Target = mxArray_tag>

pub fn duplicate(&self) -> MxArray

Create a deep copy of the array, and return as an owned type. However, consider using MatlabClass::duplicate instead if you are already working with MatlabClasses.

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

Return the sizes of the constituent dimensions of the mxArray

pub fn numel(&self) -> usize

Return the number of elements contained in this array.

pub fn raw_class_id(&self) -> u32

Return the raw class ID; the number Matlab returns.

pub fn class_id(&self) -> Result<ClassID, u32>

Return Ok(ClassID) for mxArrays which map to a built-in class (such as numeric arrays, structure arrays, and cell arrays (see ClassID); otherwise it returns the raw class ID in the Err variant. These other values of the raw class ID are used in modern versions of Matlab for custom classes, defined via e..g classdef.

pub fn is_complex(&self) -> bool

Check whether the backing array is complex. Since the only arrays which can be complex are numeric arrays, this also implies that.

pub fn is_sparse(&self) -> bool

Check whether the backing array is a sparse matrix

pub fn is_struct(&self) -> bool

Check whether the backing array is a struct array

pub fn is_empty(&self) -> bool

Check whether the backing array is empty

pub fn is_scalar(&self) -> bool

Check whether the backing array only holds one element

pub fn complexity(&self) -> Complexity

Trait Implementations

impl AsRef<mxArray_tag> for MxArray

fn as_ref(&self) -> &mxArray_tag

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<mxArray_tag> for MxArray

fn borrow(&self) -> &mxArray_tag

Immutably borrows from an owned value.

impl Clone for MxArray

fn clone(&self) -> MxArray

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MxArray

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

Formats the value using the given formatter.

impl Deref for MxArray

type Target = mxArray_tag

The resulting type after dereferencing.

fn deref(&self) -> &<MxArray as Deref>::Target

Dereferences the value.

impl DerefMut for MxArray

fn deref_mut(&mut self) -> &mut <MxArray as Deref>::Target

Mutably dereferences the value.

impl Drop for MxArray

fn drop(&mut self)

Executes the destructor for this type.

impl MatlabPtr for MxArray

fn is_a<W>(self) -> Result<W, FromMatlabError<Self>>

where W: MatlabClass<Self>, Self: Sized,

A MatlabPtr is an untyped pointer; it does not know what the type of the data it holds is. However, Rustmex provides types which represent that information. If the MatlabPtr holds one of those data types, “upcast” the pointer to that type and return it.