Struct Codec 

pub struct Codec {
    pub format: Format,
    pub channels: usize,
    pub order: ByteOrder,
    pub suppress_subnormals: bool,
}

Everything a codec call needs to know about the connection.

Fields

format: Format

The format of every channel in the stream.

channels: usize

The number of channels in one sample.

order: ByteOrder

The byte order that the connection selected.

suppress_subnormals: bool

True when the reader clears subnormal values. SPEC.md 7.4.

Implementations

impl Codec

pub fn new(format: Format, channels: usize, order: ByteOrder) -> Self

Build a codec for a stream.

pub fn with_suppress_subnormals(self, on: bool) -> Self

Return a copy that clears subnormal values on read.

impl Codec

pub fn encode(&self, s: &Sample, out: &mut Vec<u8>) -> Result<(), Error>

Write one sample to the end of out.

The layout is the tag byte, then an optional timestamp, then one value per channel. SPEC.md 7.1.

pub fn encode_to_vec(&self, s: &Sample) -> Result<Vec<u8>, Error>

Write one sample and return the bytes.

impl Codec

pub fn decode(&self, buf: &[u8]) -> Result<(Sample, usize), Error>

Read one sample from the start of buf.

Returns the sample and the number of bytes that it used.

pub fn decode_all(&self, buf: &[u8]) -> Result<(Vec<Sample>, usize), Error>

Read as many whole samples as buf holds.

Returns the samples and the number of bytes that they used. Trailing bytes that do not form a whole sample stay unread.

Trait Implementations

impl Clone for Codec

fn clone(&self) -> Codec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Codec

impl Debug for Codec

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

Formats the value using the given formatter.