pub struct InputProcessingParams { /* private fields */ }
Expand description
Input stream processing parameters.
Implementations§
Source§impl InputProcessingParams
impl InputProcessingParams
pub const ECHO_CANCELLATION: InputProcessingParams
pub const NOISE_SUPPRESSION: InputProcessingParams
pub const AUTOMATIC_GAIN_CONTROL: InputProcessingParams
pub const VOICE_ISOLATION: InputProcessingParams
Sourcepub const fn empty() -> InputProcessingParams
pub const fn empty() -> InputProcessingParams
Returns an empty set of flags.
Sourcepub const fn all() -> InputProcessingParams
pub const fn all() -> InputProcessingParams
Returns the set containing all flags.
Sourcepub const fn from_bits(bits: u32) -> Option<InputProcessingParams>
pub const fn from_bits(bits: u32) -> Option<InputProcessingParams>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Sourcepub const fn from_bits_truncate(bits: u32) -> InputProcessingParams
pub const fn from_bits_truncate(bits: u32) -> InputProcessingParams
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
Sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> InputProcessingParams
pub const unsafe fn from_bits_unchecked(bits: u32) -> InputProcessingParams
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: InputProcessingParams) -> bool
pub const fn intersects(&self, other: InputProcessingParams) -> bool
Returns true
if there are flags common to both self
and other
.
Sourcepub const fn contains(&self, other: InputProcessingParams) -> bool
pub const fn contains(&self, other: InputProcessingParams) -> bool
Returns true
if all of the flags in other
are contained within self
.
Sourcepub fn insert(&mut self, other: InputProcessingParams)
pub fn insert(&mut self, other: InputProcessingParams)
Inserts the specified flags in-place.
Sourcepub fn remove(&mut self, other: InputProcessingParams)
pub fn remove(&mut self, other: InputProcessingParams)
Removes the specified flags in-place.
Sourcepub fn toggle(&mut self, other: InputProcessingParams)
pub fn toggle(&mut self, other: InputProcessingParams)
Toggles the specified flags in-place.
Sourcepub fn set(&mut self, other: InputProcessingParams, value: bool)
pub fn set(&mut self, other: InputProcessingParams, value: bool)
Inserts or removes the specified flags depending on the passed value.
Sourcepub const fn intersection(
self,
other: InputProcessingParams,
) -> InputProcessingParams
pub const fn intersection( self, other: InputProcessingParams, ) -> InputProcessingParams
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: InputProcessingParams) -> InputProcessingParams
pub const fn union(self, other: InputProcessingParams) -> InputProcessingParams
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: InputProcessingParams,
) -> InputProcessingParams
pub const fn difference( self, other: InputProcessingParams, ) -> InputProcessingParams
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: InputProcessingParams,
) -> InputProcessingParams
pub const fn symmetric_difference( self, other: InputProcessingParams, ) -> InputProcessingParams
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) -> InputProcessingParams
pub const fn complement(self) -> InputProcessingParams
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
.
Source§impl InputProcessingParams
impl InputProcessingParams
pub const NONE: InputProcessingParams
Trait Implementations§
Source§impl Binary for InputProcessingParams
impl Binary for InputProcessingParams
Source§impl BitAnd for InputProcessingParams
impl BitAnd for InputProcessingParams
Source§fn bitand(self, other: InputProcessingParams) -> InputProcessingParams
fn bitand(self, other: InputProcessingParams) -> InputProcessingParams
Returns the intersection between the two sets of flags.
Source§type Output = InputProcessingParams
type Output = InputProcessingParams
&
operator.Source§impl BitAndAssign for InputProcessingParams
impl BitAndAssign for InputProcessingParams
Source§fn bitand_assign(&mut self, other: InputProcessingParams)
fn bitand_assign(&mut self, other: InputProcessingParams)
Disables all flags disabled in the set.
Source§impl BitOr for InputProcessingParams
impl BitOr for InputProcessingParams
Source§fn bitor(self, other: InputProcessingParams) -> InputProcessingParams
fn bitor(self, other: InputProcessingParams) -> InputProcessingParams
Returns the union of the two sets of flags.
Source§type Output = InputProcessingParams
type Output = InputProcessingParams
|
operator.Source§impl BitOrAssign for InputProcessingParams
impl BitOrAssign for InputProcessingParams
Source§fn bitor_assign(&mut self, other: InputProcessingParams)
fn bitor_assign(&mut self, other: InputProcessingParams)
Adds the set of flags.
Source§impl BitXor for InputProcessingParams
impl BitXor for InputProcessingParams
Source§fn bitxor(self, other: InputProcessingParams) -> InputProcessingParams
fn bitxor(self, other: InputProcessingParams) -> InputProcessingParams
Returns the left flags, but with all the right flags toggled.
Source§type Output = InputProcessingParams
type Output = InputProcessingParams
^
operator.Source§impl BitXorAssign for InputProcessingParams
impl BitXorAssign for InputProcessingParams
Source§fn bitxor_assign(&mut self, other: InputProcessingParams)
fn bitxor_assign(&mut self, other: InputProcessingParams)
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§const fn clone_from(&mut self, source: &Self)
const 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>(&mut self, iterator: T)where
T: IntoIterator<Item = InputProcessingParams>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = InputProcessingParams>,
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>(iterator: T) -> InputProcessingParamswhere
T: IntoIterator<Item = InputProcessingParams>,
fn from_iter<T>(iterator: T) -> InputProcessingParamswhere
T: IntoIterator<Item = InputProcessingParams>,
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§fn not(self) -> InputProcessingParams
fn not(self) -> InputProcessingParams
Returns the complement of this set of flags.
Source§type Output = InputProcessingParams
type Output = InputProcessingParams
!
operator.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§impl PartialOrd for InputProcessingParams
impl PartialOrd for InputProcessingParams
Source§impl Sub for InputProcessingParams
impl Sub for InputProcessingParams
Source§fn sub(self, other: InputProcessingParams) -> InputProcessingParams
fn sub(self, other: InputProcessingParams) -> InputProcessingParams
Returns the set difference of the two sets of flags.
Source§type Output = InputProcessingParams
type Output = InputProcessingParams
-
operator.Source§impl SubAssign for InputProcessingParams
impl SubAssign for InputProcessingParams
Source§fn sub_assign(&mut self, other: InputProcessingParams)
fn sub_assign(&mut self, other: InputProcessingParams)
Disables all flags enabled in the set.