Channel

Struct Channel 

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

High level handle for a single channel within a group.

It holds references to the raw blocks and allows convenient access to metadata and decoded values.

Implementations§

Source§

impl<'a> Channel<'a>

Source

pub fn new( block: &'a ChannelBlock, raw_data_group: &'a RawDataGroup, raw_channel_group: &'a RawChannelGroup, raw_channel: &'a RawChannel, mmap: &'a [u8], ) -> Self

Construct a new Channel from raw block references.

§Arguments
  • block - Channel block containing metadata
  • raw_data_group - Parent data group
  • raw_channel_group - Parent channel group
  • raw_channel - Raw channel helper used to iterate samples
  • mmap - Memory mapped file backing all data
§Returns

A Channel handle with no samples decoded yet.

Source

pub fn name(&self) -> Result<Option<String>>

Retrieve the channel name if present.

Source

pub fn unit(&self) -> Result<Option<String>>

Retrieve the physical unit description.

Source

pub fn comment(&self) -> Result<Option<String>>

Retrieve the channel comment if present.

Source

pub fn source(&self) -> Result<Option<SourceInfo>>

Get the acquisition source for this channel if available.

Source

pub fn values(&self) -> Result<Vec<Option<DecodedValue>>>

Decode and convert all samples of this channel.

This method decodes all channel values and applies conversions. Invalid samples (as indicated by invalidation bits) are returned as None.

§Returns

A vector with one Option<DecodedValue> per record:

  • Some(value) for valid samples
  • None for invalid samples (invalidation bit set or decoding failed)
Source

pub fn block(&self) -> &ChannelBlock

Get the channel block (for internal use)

Auto Trait Implementations§

§

impl<'a> Freeze for Channel<'a>

§

impl<'a> RefUnwindSafe for Channel<'a>

§

impl<'a> Send for Channel<'a>

§

impl<'a> Sync for Channel<'a>

§

impl<'a> Unpin for Channel<'a>

§

impl<'a> UnwindSafe for Channel<'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.