Skip to main content

BufferFlags

Struct BufferFlags 

Source
#[repr(transparent)]
pub struct BufferFlags(pub i32);
Expand description

Status of an audio buffer crossing the APO boundary.

The enum values match the Windows audio engine’s APO_BUFFER_FLAGS definitions in audioenginebaseapo.h:

VariantValueMeaning
Self::INVALID0Buffer contents undefined; ignore.
Self::VALID1Buffer contains valid audio data.
Self::SILENT2Buffer represents pure silence and may be skipped by the APO without producing audible artefacts.

Defined as a #[repr(transparent)] newtype rather than an enum so callers can round-trip the raw i32 returned by the audio engine without panicking on out-of-range values.

Tuple Fields§

§0: i32

Implementations§

Source§

impl BufferFlags

Source

pub const INVALID: Self

Buffer contents are undefined.

Source

pub const VALID: Self

Buffer contains valid audio data.

Source

pub const SILENT: Self

Buffer is entirely silence; the APO is free to skip computation for this buffer.

Source

pub const fn is_valid(self) -> bool

true iff this is exactly Self::VALID.

Source

pub const fn is_silent(self) -> bool

true iff this is exactly Self::SILENT.

Source

pub const fn is_invalid(self) -> bool

true iff this is exactly Self::INVALID.

Trait Implementations§

Source§

impl Clone for BufferFlags

Source§

fn clone(&self) -> BufferFlags

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for BufferFlags

Source§

impl Debug for BufferFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BufferFlags

Source§

fn default() -> Self

Defaults to Self::INVALID, matching the Windows audio engine’s APO_BUFFER_FLAGS::default().

Source§

impl Eq for BufferFlags

Source§

impl Hash for BufferFlags

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BufferFlags

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BufferFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.