Struct Datatype 

pub struct Datatype { /* private fields */ }

A validated SigMF core:datatype value such as cf32_le or ru8.

Construct one by parsing a string with FromStr or from its parts with Datatype::new. It serializes to and deserializes from its string form, and deserialization rejects strings that are not core SigMF datatypes.

Implementations

impl Datatype

pub fn new( domain: SampleDomain, component: Option<ComponentType>, endianness: Option<Endianness>, byte_type: Option<ByteType>, ) -> Result<Self, SigmfError>

Builds a datatype from its domain and component description.

Supply either component and endianness (for multi-byte types) or only byte_type (for single-byte types).

Errors

Returns SigmfError::InvalidDataType if any other combination of component, endianness, and byte_type is given.

Examples

use sigmf::datatype::{ByteType, ComponentType, Datatype, Endianness, SampleDomain};

let iq = Datatype::new(
    SampleDomain::Complex,
    Some(ComponentType::I16),
    Some(Endianness::BE),
    None,
)?;
assert_eq!(iq.as_str(), "ci16_be");

let bytes = Datatype::new(SampleDomain::Real, None, None, Some(ByteType::U8))?;
assert_eq!(bytes.as_str(), "ru8");

assert!(Datatype::new(SampleDomain::Real, Some(ComponentType::F32), None, None).is_err());

pub fn get_domain(&self) -> SampleDomain

Returns whether samples are real or complex.

pub fn get_dtype(&self) -> Option<ComponentType>

Returns the multi-byte component type, or None for single-byte datatypes (see get_byte).

pub fn get_endian(&self) -> Option<Endianness>

Returns the byte order, or None for single-byte datatypes.

pub fn get_byte(&self) -> Option<ByteType>

Returns the single-byte component type, or None for multi-byte datatypes (see get_dtype).

pub fn as_str(&self) -> &str

Returns the datatype string as it appears in SigMF metadata.

pub fn is_complex(&self) -> bool

Returns true if the datatype is complex (c prefix).

pub fn component_bytes(&self) -> usize

Returns the size in bytes of one component (one real value, or one of the I/Q halves of a complex value).

pub fn bytes_per_channel_sample(&self) -> usize

Returns the size in bytes of one sample on one channel.

This is component_bytes for real datatypes and twice that for complex datatypes. Multiply by core:num_channels to get the size of a frame.

Trait Implementations

impl Clone for Datatype

fn clone(&self) -> Datatype

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Datatype

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Datatype

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Datatype

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

Formats the value using the given formatter.

impl Eq for Datatype

impl FromStr for Datatype

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a core SigMF datatype string such as cf32_le or ri8.

Errors

Returns SigmfError::InvalidDataType if the string is empty, has an unknown domain or component type, is missing or has an invalid endianness suffix, or adds a suffix to a single-byte type.

type Err = SigmfError

The associated error which can be returned from parsing.

impl PartialEq for Datatype

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Datatype

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Datatype