Struct trk_io::Header

pub struct Header {
    pub affine4_to_rasmm: Affine4,
    pub affine_to_rasmm: Affine,
    pub translation: Translation,
    pub nb_streamlines: usize,
    pub scalars_name: Vec<String>,
    pub properties_name: Vec<String>,
    /* private fields */
}

Fields

affine4_to_rasmm: Affine4

affine_to_rasmm: Affine

translation: Translation

nb_streamlines: usize

scalars_name: Vec<String>

properties_name: Vec<String>

Implementations

impl Header

pub fn from_trk<P: AsRef<Path>>(path: P) -> Result<Header>

Retrieve a trk header, along with its byte order, from a file in the file system.

pub fn raw_header(&self) -> CHeader

Retrieve a copy of the original trk header, as read on disk.

pub fn read(reader: &mut BufReader<File>) -> Result<(Header, Endianness)>

Retrieve a trk header, along with its byte order, from the given BufReader. It is assumed that the reader is currently at the start of the trk header.

pub fn clear_scalars_and_properties(&mut self)

Clear all scalars and properties from self.

pub fn clear_scalars(&mut self)

Clear all scalars from self.

pub fn clear_properties(&mut self)

Clear all properties from self.

pub fn copy_scalars_and_properties(&mut self, rhs: &Self)

Clear all scalars and properties from self and copy scalars and properties from rhs.

pub fn copy_scalars(&mut self, rhs: &Self)

Clear all scalars from self and copy scalars from rhs.

pub fn copy_properties(&mut self, rhs: &Self)

Clear all properties from self and copy properties from rhs.

pub fn add_scalar(&mut self, name: &str) -> Result<()>

pub fn add_property(&mut self, name: &str) -> Result<()>

pub fn write<W: WriteBytesExt>(&self, writer: &mut W) -> Result<()>

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.