Struct autd3_core::FPGAControlFlags

#[repr(C)]
pub struct FPGAControlFlags(_);

Implementations

impl FPGAControlFlags

pub const NONE: FPGAControlFlags = Self::from_bits_retain(0)

pub const LEGACY_MODE: FPGAControlFlags = Self::from_bits_retain(1 << 0)

pub const USE_FINISH_IDX: FPGAControlFlags = Self::from_bits_retain(1 << 2)

pub const USE_START_IDX: FPGAControlFlags = Self::from_bits_retain(1 << 3)

pub const FORCE_FAN: FPGAControlFlags = Self::from_bits_retain(1 << 4)

pub const STM_MODE: FPGAControlFlags = Self::from_bits_retain(1 << 5)

pub const STM_GAIN_MODE: FPGAControlFlags = Self::from_bits_retain(1 << 6)

pub const READS_FPGA_INFO: FPGAControlFlags = Self::from_bits_retain(1 << 7)

impl FPGAControlFlags

pub const fn empty() -> FPGAControlFlags

Returns an empty set of flags.

pub const fn all() -> FPGAControlFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u8) -> Option<FPGAControlFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> FPGAControlFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn from_bits_retain(bits: u8) -> FPGAControlFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub fn from_name(name: &str) -> Option<FPGAControlFlags>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: FPGAControlFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: FPGAControlFlags) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: FPGAControlFlags)

Inserts the specified flags in-place.

This method is equivalent to union.

pub fn remove(&mut self, other: FPGAControlFlags)

Removes the specified flags in-place.

This method is equivalent to difference.

pub fn toggle(&mut self, other: FPGAControlFlags)

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

pub fn set(&mut self, other: FPGAControlFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

pub const fn union(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

pub const fn difference(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

pub const fn symmetric_difference( self, other: FPGAControlFlags ) -> FPGAControlFlags

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> FPGAControlFlags

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl FPGAControlFlags

pub const fn iter(&self) -> Iter<FPGAControlFlags>

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterNames<FPGAControlFlags>

Iterate over enabled flag values with their stringified names.

Trait Implementations

impl Binary for FPGAControlFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd<FPGAControlFlags> for FPGAControlFlags

fn bitand(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the intersection between the two sets of flags.

type Output = FPGAControlFlags

The resulting type after applying the & operator.

impl BitAndAssign<FPGAControlFlags> for FPGAControlFlags

fn bitand_assign(&mut self, other: FPGAControlFlags)

Disables all flags disabled in the set.

impl BitOr<FPGAControlFlags> for FPGAControlFlags

fn bitor(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the union of the two sets of flags.

type Output = FPGAControlFlags

The resulting type after applying the | operator.

impl BitOrAssign<FPGAControlFlags> for FPGAControlFlags

fn bitor_assign(&mut self, other: FPGAControlFlags)

Adds the set of flags.

impl BitXor<FPGAControlFlags> for FPGAControlFlags

fn bitxor(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the left flags, but with all the right flags toggled.

type Output = FPGAControlFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<FPGAControlFlags> for FPGAControlFlags

fn bitxor_assign(&mut self, other: FPGAControlFlags)

Toggles the set of flags.

impl Clone for FPGAControlFlags

fn clone(&self) -> FPGAControlFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for FPGAControlFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Extend<FPGAControlFlags> for FPGAControlFlags

fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = FPGAControlFlags>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for FPGAControlFlags

const FLAGS: &'static [Flag<FPGAControlFlags>] = &[{ ::bitflags::Flag::new("NONE", FPGAControlFlags::NONE) }, { ::bitflags::Flag::new("LEGACY_MODE", FPGAControlFlags::LEGACY_MODE) }, { ::bitflags::Flag::new("USE_FINISH_IDX", FPGAControlFlags::USE_FINISH_IDX) }, { ::bitflags::Flag::new("USE_START_IDX", FPGAControlFlags::USE_START_IDX) }, { ::bitflags::Flag::new("FORCE_FAN", FPGAControlFlags::FORCE_FAN) }, { ::bitflags::Flag::new("STM_MODE", FPGAControlFlags::STM_MODE) }, { ::bitflags::Flag::new("STM_GAIN_MODE", FPGAControlFlags::STM_GAIN_MODE) }, { ::bitflags::Flag::new("READS_FPGA_INFO", FPGAControlFlags::READS_FPGA_INFO) }]

The set of available flags and their names.

type Bits = u8

The underlying storage type.

fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u8) -> FPGAControlFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

Returns true if there are flags common to both self and other.

fn contains(&self, other: Self) -> boolwhere Self: Sized,

Returns true if all of the flags in other are contained within self.

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

fn set(&mut self, other: Self, value: bool)where Self: Sized,

Inserts or removes the specified flags depending on the passed value.

fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<FPGAControlFlags> for FPGAControlFlags

fn from_iter<T>(iterator: T) -> FPGAControlFlagswhere T: IntoIterator<Item = FPGAControlFlags>,

Creates a value from an iterator.

impl IntoIterator for FPGAControlFlags

type Item = FPGAControlFlags

The type of the elements being iterated over.

type IntoIter = Iter<FPGAControlFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <FPGAControlFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for FPGAControlFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for FPGAControlFlags

fn not(self) -> FPGAControlFlags

Returns the complement of this set of flags.

type Output = FPGAControlFlags

The resulting type after applying the ! operator.

impl Octal for FPGAControlFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Sub<FPGAControlFlags> for FPGAControlFlags

fn sub(self, other: FPGAControlFlags) -> FPGAControlFlags

Returns the set difference of the two sets of flags.

type Output = FPGAControlFlags

The resulting type after applying the - operator.

impl SubAssign<FPGAControlFlags> for FPGAControlFlags

fn sub_assign(&mut self, other: FPGAControlFlags)

Disables all flags enabled in the set.

impl UpperHex for FPGAControlFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for FPGAControlFlags