Struct DataFormat 

pub struct DataFormat { /* private fields */ }

The format of a data sample.

Implementations

impl DataFormat

pub fn length(&self) -> u32

Gets total length of the sample, in bits.

pub fn bits(&self) -> u32

Gets the length of valid data in the sample, in bits.

pub fn shift(&self) -> u32

Right-shift to apply when converting sample.

pub fn is_signed(&self) -> bool

Determines if the sample is signed

pub fn is_fully_defined(&self) -> bool

Determines if the sample is fully defined, sign extended, etc.

pub fn is_big_endian(&self) -> bool

Determines if the sample is in big-endian format

pub fn with_scale(&self) -> bool

Determinesif the sample should be scaled when converted

pub fn scale(&self) -> f64

Contains the scale to apply if with_scale is set

pub fn repeat(&self) -> u32

Number of times length repeats

pub fn byte_length(&self) -> usize

The number of bytes required to hold a single sample from the channel.

pub fn type_of(&self) -> Option<TypeId>

Gets the TypeId for a single sample from the channel.

This will get the TypeId for a sample if it can fit into a standard integer type, signed or unsigned, of 8, 16, 32, or 64 bits.

Trait Implementations

impl Clone for DataFormat

fn clone(&self) -> DataFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataFormat

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

Formats the value using the given formatter.

impl Copy for DataFormat