pub struct DebugFlags(/* private fields */);
Expand description
Specify the requested information to be output when using the logging version of FMOD.
Implementations§
Source§impl DebugFlags
impl DebugFlags
Sourcepub const MEMORY: Self
pub const MEMORY: Self
Verbose logging for memory operations, only use this if you are debugging a memory related issue.
Sourcepub const FILE: Self
pub const FILE: Self
Verbose logging for file access, only use this if you are debugging a file related issue.
Sourcepub const CODEC: Self
pub const CODEC: Self
Verbose logging for codec initialization, only use this if you are debugging a codec related issue.
Sourcepub const TRACE: Self
pub const TRACE: Self
Verbose logging for internal errors, use this for tracking the origin of error codes.
Sourcepub const DISPLAY_TIMESTAMPS: Self
pub const DISPLAY_TIMESTAMPS: Self
Display the time stamp of the log message in milliseconds.
Sourcepub const DISPLAY_LINENUMBERS: Self
pub const DISPLAY_LINENUMBERS: Self
Display the source code file and line number for where the message originated.
Sourcepub const DISPLAY_THREAD: Self
pub const DISPLAY_THREAD: Self
Display the thread ID of the calling function that generated the message.
Source§impl DebugFlags
impl DebugFlags
Sourcepub const fn bits(&self) -> FMOD_DEBUG_FLAGS
pub const fn bits(&self) -> FMOD_DEBUG_FLAGS
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
Sourcepub const fn from_bits(bits: FMOD_DEBUG_FLAGS) -> Option<Self>
pub const fn from_bits(bits: FMOD_DEBUG_FLAGS) -> 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: FMOD_DEBUG_FLAGS) -> Self
pub const fn from_bits_truncate(bits: FMOD_DEBUG_FLAGS) -> Self
Convert from a bits value, unsetting any unknown bits.
Sourcepub const fn from_bits_retain(bits: FMOD_DEBUG_FLAGS) -> Self
pub const fn from_bits_retain(bits: FMOD_DEBUG_FLAGS) -> 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 DebugFlags
impl DebugFlags
Sourcepub const fn iter(&self) -> Iter<DebugFlags>
pub const fn iter(&self) -> Iter<DebugFlags>
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<DebugFlags>
pub const fn iter_names(&self) -> IterNames<DebugFlags>
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 DebugFlags
impl Binary for DebugFlags
Source§impl BitAnd for DebugFlags
impl BitAnd for DebugFlags
Source§impl BitAndAssign for DebugFlags
impl BitAndAssign for DebugFlags
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 DebugFlags
impl BitOr for DebugFlags
Source§fn bitor(self, other: DebugFlags) -> Self
fn bitor(self, other: DebugFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
Source§type Output = DebugFlags
type Output = DebugFlags
|
operator.Source§impl BitOrAssign for DebugFlags
impl BitOrAssign for DebugFlags
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 DebugFlags
impl BitXor for DebugFlags
Source§impl BitXorAssign for DebugFlags
impl BitXorAssign for DebugFlags
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 DebugFlags
impl Clone for DebugFlags
Source§fn clone(&self) -> DebugFlags
fn clone(&self) -> DebugFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DebugFlags
impl Debug for DebugFlags
Source§impl Extend<DebugFlags> for DebugFlags
impl Extend<DebugFlags> for DebugFlags
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 DebugFlags
impl Flags for DebugFlags
Source§const FLAGS: &'static [Flag<DebugFlags>]
const FLAGS: &'static [Flag<DebugFlags>]
Source§fn bits(&self) -> FMOD_DEBUG_FLAGS
fn bits(&self) -> FMOD_DEBUG_FLAGS
Source§fn from_bits_retain(bits: FMOD_DEBUG_FLAGS) -> DebugFlags
fn from_bits_retain(bits: FMOD_DEBUG_FLAGS) -> DebugFlags
Source§fn contains_unknown_bits(&self) -> bool
fn contains_unknown_bits(&self) -> bool
true
if any unknown bits are set.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 From<DebugFlags> for FMOD_DEBUG_FLAGS
impl From<DebugFlags> for FMOD_DEBUG_FLAGS
Source§fn from(value: DebugFlags) -> Self
fn from(value: DebugFlags) -> Self
Source§impl From<u32> for DebugFlags
impl From<u32> for DebugFlags
Source§fn from(value: FMOD_DEBUG_FLAGS) -> Self
fn from(value: FMOD_DEBUG_FLAGS) -> Self
Source§impl FromIterator<DebugFlags> for DebugFlags
impl FromIterator<DebugFlags> for DebugFlags
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 DebugFlags
impl IntoIterator for DebugFlags
Source§impl LowerHex for DebugFlags
impl LowerHex for DebugFlags
Source§impl Not for DebugFlags
impl Not for DebugFlags
Source§impl Octal for DebugFlags
impl Octal for DebugFlags
Source§impl Ord for DebugFlags
impl Ord for DebugFlags
Source§fn cmp(&self, other: &DebugFlags) -> Ordering
fn cmp(&self, other: &DebugFlags) -> 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 DebugFlags
impl PartialEq for DebugFlags
Source§impl PartialOrd for DebugFlags
impl PartialOrd for DebugFlags
Source§impl PublicFlags for DebugFlags
impl PublicFlags for DebugFlags
Source§impl Sub for DebugFlags
impl Sub for DebugFlags
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.
Source§type Output = DebugFlags
type Output = DebugFlags
-
operator.Source§impl SubAssign for DebugFlags
impl SubAssign for DebugFlags
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.