Enum libpulse_binding::sample::Format

#[repr(C)]
pub enum Format {
    U8,
    ALaw,
    ULaw,
    S16le,
    S16be,
    F32le,
    F32be,
    S32le,
    S32be,
    S24le,
    S24be,
    S24_32le,
    S24_32be,
    Invalid,
}

Sample format

Variants

U8

Unsigned 8 Bit PCM.

ALaw

8 Bit a-Law.

ULaw

8 Bit mu-Law.

S16le

Signed 16 Bit PCM, little endian (PC).

S16be

Signed 16 Bit PCM, big endian.

F32le

32 Bit IEEE floating point, little endian (PC), range -1.0 to 1.0.

F32be

32 Bit IEEE floating point, big endian, range -1.0 to 1.0.

S32le

Signed 32 Bit PCM, little endian (PC).

S32be

Signed 32 Bit PCM, big endian.

S24le

Signed 24 Bit PCM packed, little endian (PC).

S24be

Signed 24 Bit PCM packed, big endian.

S24_32le

Signed 24 Bit PCM in LSB of 32 Bit words, little endian (PC).

S24_32be

Signed 24 Bit PCM in LSB of 32 Bit words, big endian.

Invalid

An invalid value.

Methods

impl Format

pub fn size(&self) -> usize

Similar to Spec::sample_size but take a sample format instead of full sample spec.

pub fn to_string(&self) -> Option<Cow<'static, str>>

Returns a descriptive string for the specified sample format.

pub fn parse(format: &str) -> Self

Parse a sample format text. Inverse of to_string.

pub fn is_le(&self) -> Option<bool>

Returns true when the specified format is little endian, false if big endian. Returns None when endianness does not apply to this format, or if unknown.

pub fn is_be(&self) -> Option<bool>

Returns true when the specified format is big endian, false if little endian. Returns None when endianness does not apply to this format, or if unknown.

pub fn is_ne(&self) -> Option<bool>

Is format native endian?

Returns true when the specified format is native endian, false when not. Returns None when endianness does not apply to the specified format, or endianness is unknown.

pub fn is_re(&self) -> Option<bool>

Is format reverse of native endian?

Returns true when the specified format is reverse endian, false when not. Returns None when endianness does not apply to the specified format, or endianness is unknown.

Trait Implementations

impl Copy for Format

impl PartialEq<Format> for Format

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Default for Format

fn default() -> Self

Returns the "default value" for a type.

impl From<Format> for pa_sample_format_t

fn from(f: Format) -> Self

Performs the conversion.

impl From<pa_sample_format_t> for Format

fn from(f: pa_sample_format_t) -> Self

Performs the conversion.

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Format

impl Debug for Format

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

Formats the value using the given formatter.