Struct rtaudio::StreamFlags
source · #[repr(C)]pub struct StreamFlags(/* private fields */);
Expand description
Stream option flags.
Implementations§
source§impl StreamFlags
impl StreamFlags
sourcepub const NONINTERLEAVED: Self = _
pub const NONINTERLEAVED: Self = _
Use non-interleaved buffers (default = interleaved).
sourcepub const MINIMIZE_LATENCY: Self = _
pub const MINIMIZE_LATENCY: Self = _
Attempt to set stream parameters for lowest possible latency, with the possible expense of stream performance.
sourcepub const HOG_DEVICE: Self = _
pub const HOG_DEVICE: Self = _
Attempt to grab the device for exclusive use.
Note that this is not possible with all supported audio APIs.
sourcepub const SCHEDULE_REALTIME: Self = _
pub const SCHEDULE_REALTIME: Self = _
Attempt to select realtime scheduling (round-robin) for the callback thread.
sourcepub const ALSA_USE_DEFAULT: Self = _
pub const ALSA_USE_DEFAULT: Self = _
Attempt to open the “default” PCM device when using the ALSA API. Note that this will override any specified input or output device index.
sourcepub const JACK_DONT_CONNECT: Self = _
pub const JACK_DONT_CONNECT: Self = _
Do not automatically connect ports (JACK only).
source§impl StreamFlags
impl StreamFlags
sourcepub const fn bits(&self) -> rtaudio_stream_flags_t
pub const fn bits(&self) -> rtaudio_stream_flags_t
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: rtaudio_stream_flags_t) -> Option<Self>
pub const fn from_bits(bits: rtaudio_stream_flags_t) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: rtaudio_stream_flags_t) -> Self
pub const fn from_bits_truncate(bits: rtaudio_stream_flags_t) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: rtaudio_stream_flags_t) -> Self
pub const fn from_bits_retain(bits: rtaudio_stream_flags_t) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl StreamFlags
impl StreamFlags
sourcepub const fn iter(&self) -> Iter<StreamFlags>
pub const fn iter(&self) -> Iter<StreamFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<StreamFlags>
pub const fn iter_names(&self) -> IterNames<StreamFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for StreamFlags
impl Binary for StreamFlags
source§impl BitAnd for StreamFlags
impl BitAnd for StreamFlags
source§impl BitAndAssign for StreamFlags
impl BitAndAssign for StreamFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for StreamFlags
impl BitOr for StreamFlags
source§fn bitor(self, other: StreamFlags) -> Self
fn bitor(self, other: StreamFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = StreamFlags
type Output = StreamFlags
|
operator.source§impl BitOrAssign for StreamFlags
impl BitOrAssign for StreamFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for StreamFlags
impl BitXor for StreamFlags
source§impl BitXorAssign for StreamFlags
impl BitXorAssign for StreamFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for StreamFlags
impl Clone for StreamFlags
source§fn clone(&self) -> StreamFlags
fn clone(&self) -> StreamFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StreamFlags
impl Debug for StreamFlags
source§impl Extend<StreamFlags> for StreamFlags
impl Extend<StreamFlags> for StreamFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for StreamFlags
impl Flags for StreamFlags
source§const FLAGS: &'static [Flag<StreamFlags>] = _
const FLAGS: &'static [Flag<StreamFlags>] = _
source§fn bits(&self) -> rtaudio_stream_flags_t
fn bits(&self) -> rtaudio_stream_flags_t
source§fn from_bits_retain(bits: rtaudio_stream_flags_t) -> StreamFlags
fn from_bits_retain(bits: rtaudio_stream_flags_t) -> StreamFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<StreamFlags> for StreamFlags
impl FromIterator<StreamFlags> for StreamFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for StreamFlags
impl IntoIterator for StreamFlags
source§impl LowerHex for StreamFlags
impl LowerHex for StreamFlags
source§impl Not for StreamFlags
impl Not for StreamFlags
source§impl Octal for StreamFlags
impl Octal for StreamFlags
source§impl Ord for StreamFlags
impl Ord for StreamFlags
source§fn cmp(&self, other: &StreamFlags) -> Ordering
fn cmp(&self, other: &StreamFlags) -> 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 StreamFlags
impl PartialEq for StreamFlags
source§fn eq(&self, other: &StreamFlags) -> bool
fn eq(&self, other: &StreamFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for StreamFlags
impl PartialOrd for StreamFlags
source§fn partial_cmp(&self, other: &StreamFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StreamFlags) -> 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 PublicFlags for StreamFlags
impl PublicFlags for StreamFlags
source§impl Sub for StreamFlags
impl Sub for StreamFlags
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = StreamFlags
type Output = StreamFlags
-
operator.source§impl SubAssign for StreamFlags
impl SubAssign for StreamFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.