Struct adxl343::DataFormatFlags

pub struct DataFormatFlags { /* fields omitted */ }

Flags passed as operands to Register::DATA_FORMAT

"The DATA_FORMAT register controls the presentation of data to Register 0x32 through Register 0x37. All data, except that for the ±16 g range, must be clipped to avoid rollover."

Methods

impl DataFormatFlags

pub const SELF_TEST: DataFormatFlags

"A setting of 1 in the SELF_TEST bit applies a self-test force to the sensor, causing a shift in the output data. A value of 0 disables the self-test force."

pub const SPI: DataFormatFlags

"A value of 1 in the SPI bit sets the device to 3-wire SPI mode, and a value of 0 sets the device to 4-wire SPI mode"

pub const INT_INVERT: DataFormatFlags

"A value of 0 in the INT_INVERT bit sets the interrupts to active high, and a value of 1 sets the interrupts to active low."

pub const FULL_RES: DataFormatFlags

"When this bit is set to a value of 1, the device is in full resolution mode, where the output resolution increases with the g range set by the range bits to maintain a 4 mg/LSB scale factor. When the FULL_RES bit is set to 0, the device is in 10-bit mode, and the range bits determine the maximum g range and scale factor"

pub const JUSTIFY: DataFormatFlags

A setting of 1 in the justify bit selects left-justified (MSB) mode, and a setting of 0 selects right-justified mode with sign extension.

pub const RANGE_HI: DataFormatFlags

Range high bit (see DataFormatRange)

pub const RANGE_LO: DataFormatFlags

Range low bit (see DataFormatRange)

pub const fn empty() -> DataFormatFlags

Returns an empty set of flags

pub const fn all() -> DataFormatFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

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) -> DataFormatFlags

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

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: DataFormatFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl PartialEq<DataFormatFlags> for DataFormatFlags

fn eq(&self, other: &DataFormatFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataFormatFlags) -> bool

This method tests for !=.

impl Eq for DataFormatFlags

impl Ord for DataFormatFlags

fn cmp(&self, other: &DataFormatFlags) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<DataFormatFlags> for DataFormatFlags

fn partial_cmp(&self, other: &DataFormatFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DataFormatFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DataFormatFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DataFormatFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DataFormatFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Hash for DataFormatFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Copy for DataFormatFlags

impl Sub<DataFormatFlags> for DataFormatFlags

type Output = DataFormatFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<DataFormatFlags> for DataFormatFlags

fn sub_assign(&mut self, other: DataFormatFlags)

Disables all flags enabled in the set.

impl Not for DataFormatFlags

type Output = DataFormatFlags

The resulting type after applying the ! operator.

fn not(self) -> DataFormatFlags

Returns the complement of this set of flags.

impl BitAnd<DataFormatFlags> for DataFormatFlags

type Output = DataFormatFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<DataFormatFlags> for DataFormatFlags

type Output = DataFormatFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<DataFormatFlags> for DataFormatFlags

type Output = DataFormatFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<DataFormatFlags> for DataFormatFlags

fn bitand_assign(&mut self, other: DataFormatFlags)

Disables all flags disabled in the set.

impl BitOrAssign<DataFormatFlags> for DataFormatFlags

fn bitor_assign(&mut self, other: DataFormatFlags)

Adds the set of flags.

impl BitXorAssign<DataFormatFlags> for DataFormatFlags

fn bitxor_assign(&mut self, other: DataFormatFlags)

Toggles the set of flags.

impl Debug for DataFormatFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<DataFormatRange> for DataFormatFlags

fn from(range: DataFormatRange) -> DataFormatFlags

Performs the conversion.

impl FromIterator<DataFormatFlags> for DataFormatFlags

fn from_iter<T: IntoIterator<Item = DataFormatFlags>>(
    iterator: T
) -> DataFormatFlags

Creates a value from an iterator.

impl Octal for DataFormatFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Binary for DataFormatFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl LowerHex for DataFormatFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl UpperHex for DataFormatFlags

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Extend<DataFormatFlags> for DataFormatFlags

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

Extends a collection with the contents of an iterator.

impl Clone for DataFormatFlags

fn clone(&self) -> DataFormatFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for DataFormatFlags

Default DATA_FORMAT settings:

• SELF_TEST: false
• SPI: false
• INT_INVERT: false
• FULL_RES: false
• JUSTIFY: false
• Range: ±2g (i.e. 0)

fn default() -> Self

Returns the "default value" for a type.