Struct cubeb_core::InputProcessingParams
source · pub struct InputProcessingParams { /* private fields */ }
Expand description
Input stream processing parameters.
Implementations§
source§impl InputProcessingParams
impl InputProcessingParams
pub const ECHO_CANCELLATION: Self = _
pub const NOISE_SUPPRESSION: Self = _
pub const AUTOMATIC_GAIN_CONTROL: Self = _
pub const VOICE_ISOLATION: Self = _
sourcepub const fn bits(&self) -> cubeb_input_processing_params
pub const fn bits(&self) -> cubeb_input_processing_params
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: cubeb_input_processing_params) -> Option<Self>
pub const fn from_bits(bits: cubeb_input_processing_params) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: cubeb_input_processing_params) -> Self
pub const fn from_bits_truncate(bits: cubeb_input_processing_params) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(
bits: cubeb_input_processing_params
) -> Self
pub const unsafe fn from_bits_unchecked( bits: cubeb_input_processing_params ) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for InputProcessingParams
impl Binary for InputProcessingParams
source§impl BitAnd for InputProcessingParams
impl BitAnd for InputProcessingParams
source§impl BitAndAssign for InputProcessingParams
impl BitAndAssign for InputProcessingParams
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for InputProcessingParams
impl BitOr for InputProcessingParams
source§fn bitor(self, other: InputProcessingParams) -> Self
fn bitor(self, other: InputProcessingParams) -> Self
Returns the union of the two sets of flags.
§type Output = InputProcessingParams
type Output = InputProcessingParams
|
operator.source§impl BitOrAssign for InputProcessingParams
impl BitOrAssign for InputProcessingParams
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for InputProcessingParams
impl BitXor for InputProcessingParams
source§impl BitXorAssign for InputProcessingParams
impl BitXorAssign for InputProcessingParams
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for InputProcessingParams
impl Clone for InputProcessingParams
source§fn clone(&self) -> InputProcessingParams
fn clone(&self) -> InputProcessingParams
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for InputProcessingParams
impl Debug for InputProcessingParams
source§impl Extend<InputProcessingParams> for InputProcessingParams
impl Extend<InputProcessingParams> for InputProcessingParams
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<InputProcessingParams> for InputProcessingParams
impl FromIterator<InputProcessingParams> for InputProcessingParams
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for InputProcessingParams
impl Hash for InputProcessingParams
source§impl LowerHex for InputProcessingParams
impl LowerHex for InputProcessingParams
source§impl Not for InputProcessingParams
impl Not for InputProcessingParams
source§impl Octal for InputProcessingParams
impl Octal for InputProcessingParams
source§impl Ord for InputProcessingParams
impl Ord for InputProcessingParams
source§fn cmp(&self, other: &InputProcessingParams) -> Ordering
fn cmp(&self, other: &InputProcessingParams) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for InputProcessingParams
impl PartialEq for InputProcessingParams
source§fn eq(&self, other: &InputProcessingParams) -> bool
fn eq(&self, other: &InputProcessingParams) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for InputProcessingParams
impl PartialOrd for InputProcessingParams
source§fn partial_cmp(&self, other: &InputProcessingParams) -> Option<Ordering>
fn partial_cmp(&self, other: &InputProcessingParams) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for InputProcessingParams
impl Sub for InputProcessingParams
source§impl SubAssign for InputProcessingParams
impl SubAssign for InputProcessingParams
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.