Enum Format 

#[repr(C)]
pub enum Format {
    U8 = 0,
    ALaw = 1,
    ULaw = 2,
    S16le = 3,
    S16be = 4,
    F32le = 5,
    F32be = 6,
    S32le = 7,
    S32be = 8,
    S24le = 9,
    S24be = 10,
    S24_32le = 11,
    S24_32be = 12,
    Invalid = -1,
}

Sample format.

Note, native-endian (endian-independent) associated constants are available on this type which should be preferred over direct use of the endian-specific variants, for improved flexibility and avoidance of mistakes.

Variants

U8 = 0

Unsigned 8 Bit PCM.

ALaw = 1

8 Bit a-Law.

ULaw = 2

8 Bit mu-Law.

S16le = 3

Signed 16 Bit PCM, little endian (PC).

S16be = 4

Signed 16 Bit PCM, big endian.

F32le = 5

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

F32be = 6

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

S32le = 7

Signed 32 Bit PCM, little endian (PC).

S32be = 8

Signed 32 Bit PCM, big endian.

S24le = 9

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

S24be = 10

Signed 24 Bit PCM packed, big endian.

S24_32le = 11

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

S24_32be = 12

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

Invalid = -1

An invalid value.

Implementations

impl Format

pub const S16NE: Self = self::ei_formats::SAMPLE_S16NE

Signed 16-bit PCM, native endian.

pub const FLOAT32NE: Self = self::ei_formats::SAMPLE_FLOAT32NE

32-bit IEEE floating point, native endian.

pub const S32NE: Self = self::ei_formats::SAMPLE_S32NE

Signed 32-bit PCM, native endian.

pub const S24NE: Self = self::ei_formats::SAMPLE_S24NE

Signed 24-bit PCM packed, native endian.

pub const S24_32NE: Self = self::ei_formats::SAMPLE_S24_32NE

Signed 24-bit PCM in LSB of 32-bit words, native endian.

pub const S16RE: Self = self::ei_formats::SAMPLE_S16RE

Signed 16-bit PCM reverse endian.

pub const FLOAT32RE: Self = self::ei_formats::SAMPLE_FLOAT32RE

32-bit IEEE floating point, reverse endian.

pub const S32RE: Self = self::ei_formats::SAMPLE_S32RE

Signed 32-bit PCM, reverse endian.

pub const S24RE: Self = self::ei_formats::SAMPLE_S24RE

Signed 24-bit PCM, packed reverse endian.

pub const S24_32RE: Self = self::ei_formats::SAMPLE_S24_32RE

Signed 24-bit PCM, in LSB of 32-bit words, reverse endian.

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>>

Gets a descriptive string for the specified sample format.

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

Parses a sample format text. Inverse of to_string().

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

Checks if format is little endian.

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>

Checks if format is big endian.

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>

Checks if format is 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>

Checks if format is 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 Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl From<Format> for pa_sample_format_t

fn from(f: Format) -> Self

Converts to this type from the input type.

impl From<pa_sample_format_t> for Format

fn from(f: pa_sample_format_t) -> Self

Converts to this type from the input type.

impl FromPrimitive for Format

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl PartialEq for Format

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToPrimitive for Format

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format