Struct tdms::TDMSFile

pub struct TDMSFile<'a> {
    pub segments: Vec<Segment>,
    /* private fields */
}

TDDMSFile represents all segments of a TDMS file in the order in which they were read.

Fields

segments: Vec<Segment>

Implementations

impl<'a> TDMSFile<'a>

pub fn from_path(path: &'a Path) -> Result<Self, TdmsError>

from_path expects a path and whether or not to read only the metadata of each segment vs the entire file into working memory.

pub fn groups(&self) -> Vec<String>

groups returns all possible groups throughout the file

pub fn channels(&self, group_path: &str) -> IndexMap<String, &Channel>

pub fn channel_data_double_float(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f64, File>, TdmsError>

returns a channel who’s type is the native rust type equivalent to TdmsDoubleFloat, in this case f64 - the channel implements Iterator and using said iterator will let you move through the channel’s raw data if any exists

pub fn channel_data_single_float(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f32, File>, TdmsError>

pub fn channel_data_complex_double_float(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f64, File>, TdmsError>

pub fn channel_data_complex_single_float(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f32, File>, TdmsError>

pub fn channel_data_double_float_unit(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f64, File>, TdmsError>

pub fn channel_data_single_float_unit(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, f32, File>, TdmsError>

pub fn channel_data_i8(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, i8, File>, TdmsError>

pub fn channel_data_i16(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, i16, File>, TdmsError>

pub fn channel_data_i32(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, i32, File>, TdmsError>

pub fn channel_data_i64(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, i64, File>, TdmsError>

pub fn channel_data_u8(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, u8, File>, TdmsError>

pub fn channel_data_u16(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, u16, File>, TdmsError>

pub fn channel_data_u32(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, u32, File>, TdmsError>

pub fn channel_data_u64(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, u64, File>, TdmsError>

pub fn channel_data_bool(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, bool, File>, TdmsError>

pub fn channel_data_timestamp(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, TdmsTimestamp, File>, TdmsError>

pub fn channel_data_string(
    &self,
    channel: &'a Channel
) -> Result<ChannelDataIter<'_, String, File>, TdmsError>

Trait Implementations

impl<'a> Clone for TDMSFile<'a>

fn clone(&self) -> TDMSFile<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TDMSFile<'a>

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

Formats the value using the given formatter.