TdmsChannel

Struct TdmsChannel 

Source
pub struct TdmsChannel<'a> { /* private fields */ }
Expand description

A channel within a TDMS group.

Implementations§

Source§

impl<'a> TdmsChannel<'a>

Source

pub fn name(&self) -> &str

Return the channel name.

Source

pub fn dtype(&self) -> DataType

Return the channel data type.

Source

pub fn len(&self) -> usize

Return the number of values in the channel.

Source

pub fn is_empty(&self) -> bool

Returns true if the channel contains no values.

Source

pub fn property(&self, name: &str) -> Option<&PropertyValue>

Look up a channel-level property by name.

Source

pub fn properties(&self) -> impl Iterator<Item = (&str, &PropertyValue)>

Iterate over all channel-level properties.

Source

pub fn read<T: Pod>(&self, range: Range<usize>, out: &mut [T]) -> Result<usize>

Read a range of values into the provided output buffer.

The element type T must match the TDMS channel element size.

Source

pub fn timestamps(&self) -> Option<TimestampIterator>

If the waveform timing properties are present, return an iterator of timestamps (in seconds) corresponding to each sample.

Auto Trait Implementations§

§

impl<'a> Freeze for TdmsChannel<'a>

§

impl<'a> RefUnwindSafe for TdmsChannel<'a>

§

impl<'a> Send for TdmsChannel<'a>

§

impl<'a> Sync for TdmsChannel<'a>

§

impl<'a> Unpin for TdmsChannel<'a>

§

impl<'a> UnwindSafe for TdmsChannel<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.