Struct cryiorust::mar::Mar

pub struct Mar { /* fields omitted */ }

Main exported struct.

Implementations

impl Mar

pub fn new() -> Mar

Creates a new empty Mar struct.

pub fn read_file<P: AsRef<Path>>(path: P) -> FrameResult<Mar>

Reads a Mar frame from a file.

Trait Implementations

impl Frame for Mar

fn array(&self) -> &Array

Reimplemented method returning a reference of the Array.

fn header(&self) -> &Header

Reimplemented method returning a reference of the Header.

fn header_mut(&mut self) -> &mut Header

Reimplemented method returning a mutable reference of the Header.

fn array_mut(&mut self) -> &mut Array

Reimplemented method returning a mutable reference of the Array.

fn set_array(&mut self, array: Array)

Reimplemented method which changes Array in the Frame.

fn consume_array(self: Box<Self>) -> Array

Reimplemented method which returns Array consuming the Frame.

fn take_array(&mut self) -> Array

Reimplemented method which returns Array consuming the Frame.

fn next_frame(&mut self) -> FrameResult<usize>

Switches Frame to the next sub-frame.

fn total_frames(&self) -> usize

Returns total number of sub-frames.

fn current_frame(&self) -> usize

Returns the current frame number.

fn is_multi(&self) -> bool

Checks whether this Frame contains sub-frames.

fn sum(&self) -> f64

Returns the sum of the Frame’s Array.

fn min(&self) -> f64

Returns the minimum value of the Frame’s Array.

fn max(&self) -> f64

Returns the maximum value of the Frame’s Array.

fn dim1(&self) -> usize

Returns the first dimension of the Frame’s Array.

fn dim2(&self) -> usize

Returns the second dimension of the Frame’s Array.

fn get_header_i64(&self, key: &str) -> FrameResult<i64>

Returns an i64 value from the Frame’s Header.

fn get_header_str_or_empty(&self, key: &str) -> &str

Returns an &str value from the Frame’s Header or empty &str if the key does not exist.

fn get_header_float(&self, key: &str) -> f64

Returns an f64 value from the Frame’s Header or zero if the key does not exist.

fn get_header_str(&self, key: &str) -> FrameResult<&str>

Returns an &str value from the Frame’s Header.

fn get_header_float_as_string_or_empty(&self, key: &str, exp: bool) -> String

Returns a String value from the Frame’s Header. The String is empty if the key does not exist.

fn get_header_int_as_string_or_empty(&self, key: &str) -> String

fn get_header_str_as_i64(&self, key: &str) -> FrameResult<i64>

fn insert(&mut self, key: String, value: HeaderEntry)

Inserts a HeaderEntry value into the Frame’s Header with a String as key.

fn swap_dims(&mut self)

Swaps dims of the Frame’s Array.