Struct autd3_driver::fpga::FPGAControlFlags
source · [−]pub struct FPGAControlFlags { /* private fields */ }
Implementations
sourceimpl FPGAControlFlags
impl FPGAControlFlags
pub const NONE: Self = Self{bits: 0,}
pub const LEGACY_MODE: Self = Self{bits: 1 << 0,}
pub const FORCE_FAN: Self = Self{bits: 1 << 4,}
pub const STM_MODE: Self = Self{bits: 1 << 5,}
pub const STM_GAIN_MODE: Self = Self{bits: 1 << 6,}
pub const READS_FPGA_INFO: Self = Self{bits: 1 << 7,}
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> 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: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> 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
sourceimpl Binary for FPGAControlFlags
impl Binary for FPGAControlFlags
sourceimpl BitAnd<FPGAControlFlags> for FPGAControlFlags
impl BitAnd<FPGAControlFlags> for FPGAControlFlags
type Output = FPGAControlFlags
type Output = FPGAControlFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<FPGAControlFlags> for FPGAControlFlags
impl BitAndAssign<FPGAControlFlags> for FPGAControlFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<FPGAControlFlags> for FPGAControlFlags
impl BitOr<FPGAControlFlags> for FPGAControlFlags
sourcefn bitor(self, other: FPGAControlFlags) -> Self
fn bitor(self, other: FPGAControlFlags) -> Self
Returns the union of the two sets of flags.
type Output = FPGAControlFlags
type Output = FPGAControlFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<FPGAControlFlags> for FPGAControlFlags
impl BitOrAssign<FPGAControlFlags> for FPGAControlFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<FPGAControlFlags> for FPGAControlFlags
impl BitXor<FPGAControlFlags> for FPGAControlFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = FPGAControlFlags
type Output = FPGAControlFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<FPGAControlFlags> for FPGAControlFlags
impl BitXorAssign<FPGAControlFlags> for FPGAControlFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for FPGAControlFlags
impl Clone for FPGAControlFlags
sourcefn clone(&self) -> FPGAControlFlags
fn clone(&self) -> FPGAControlFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for FPGAControlFlags
impl Debug for FPGAControlFlags
sourceimpl Extend<FPGAControlFlags> for FPGAControlFlags
impl Extend<FPGAControlFlags> for FPGAControlFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<FPGAControlFlags> for FPGAControlFlags
impl FromIterator<FPGAControlFlags> for FPGAControlFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for FPGAControlFlags
impl Hash for FPGAControlFlags
sourceimpl LowerHex for FPGAControlFlags
impl LowerHex for FPGAControlFlags
sourceimpl Not for FPGAControlFlags
impl Not for FPGAControlFlags
type Output = FPGAControlFlags
type Output = FPGAControlFlags
The resulting type after applying the !
operator.
sourceimpl Octal for FPGAControlFlags
impl Octal for FPGAControlFlags
sourceimpl Ord for FPGAControlFlags
impl Ord for FPGAControlFlags
sourceimpl PartialEq<FPGAControlFlags> for FPGAControlFlags
impl PartialEq<FPGAControlFlags> for FPGAControlFlags
sourcefn eq(&self, other: &FPGAControlFlags) -> bool
fn eq(&self, other: &FPGAControlFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &FPGAControlFlags) -> bool
fn ne(&self, other: &FPGAControlFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<FPGAControlFlags> for FPGAControlFlags
impl PartialOrd<FPGAControlFlags> for FPGAControlFlags
sourcefn partial_cmp(&self, other: &FPGAControlFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &FPGAControlFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<FPGAControlFlags> for FPGAControlFlags
impl Sub<FPGAControlFlags> for FPGAControlFlags
type Output = FPGAControlFlags
type Output = FPGAControlFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<FPGAControlFlags> for FPGAControlFlags
impl SubAssign<FPGAControlFlags> for FPGAControlFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for FPGAControlFlags
impl UpperHex for FPGAControlFlags
impl Copy for FPGAControlFlags
impl Eq for FPGAControlFlags
impl StructuralEq for FPGAControlFlags
impl StructuralPartialEq for FPGAControlFlags
Auto Trait Implementations
impl RefUnwindSafe for FPGAControlFlags
impl Send for FPGAControlFlags
impl Sync for FPGAControlFlags
impl Unpin for FPGAControlFlags
impl UnwindSafe for FPGAControlFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more