Struct bme680::DesiredSensorSettings
source · pub struct DesiredSensorSettings { /* private fields */ }
Expand description
Flags that determine what settings are to be set and what settings are to be read.
Use the SettingsBuilder
to initialize an instance when setting the settings.
Implementations
sourceimpl DesiredSensorSettings
impl DesiredSensorSettings
sourcepub const GAS_MEAS_SEL: Self = _
pub const GAS_MEAS_SEL: Self = _
To set gas measurement setting.
sourcepub const FILTER_SEL: Self = _
pub const FILTER_SEL: Self = _
To set filter setting.
sourcepub const HCNTRL_SEL: Self = _
pub const HCNTRL_SEL: Self = _
To set humidity control setting.
sourcepub const RUN_GAS_SEL: Self = _
pub const RUN_GAS_SEL: Self = _
To set run gas setting.
sourcepub const NBCONV_SEL: Self = _
pub const NBCONV_SEL: Self = _
To set NB conversion setting.
sourcepub const GAS_SENSOR_SEL: Self = _
pub const GAS_SENSOR_SEL: Self = _
To set all gas sensor related settings
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 DesiredSensorSettings
impl Binary for DesiredSensorSettings
sourceimpl BitAnd<DesiredSensorSettings> for DesiredSensorSettings
impl BitAnd<DesiredSensorSettings> for DesiredSensorSettings
type Output = DesiredSensorSettings
type Output = DesiredSensorSettings
&
operator.sourceimpl BitAndAssign<DesiredSensorSettings> for DesiredSensorSettings
impl BitAndAssign<DesiredSensorSettings> for DesiredSensorSettings
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<DesiredSensorSettings> for DesiredSensorSettings
impl BitOr<DesiredSensorSettings> for DesiredSensorSettings
sourcefn bitor(self, other: DesiredSensorSettings) -> Self
fn bitor(self, other: DesiredSensorSettings) -> Self
Returns the union of the two sets of flags.
type Output = DesiredSensorSettings
type Output = DesiredSensorSettings
|
operator.sourceimpl BitOrAssign<DesiredSensorSettings> for DesiredSensorSettings
impl BitOrAssign<DesiredSensorSettings> for DesiredSensorSettings
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<DesiredSensorSettings> for DesiredSensorSettings
impl BitXor<DesiredSensorSettings> for DesiredSensorSettings
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 = DesiredSensorSettings
type Output = DesiredSensorSettings
^
operator.sourceimpl BitXorAssign<DesiredSensorSettings> for DesiredSensorSettings
impl BitXorAssign<DesiredSensorSettings> for DesiredSensorSettings
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for DesiredSensorSettings
impl Clone for DesiredSensorSettings
sourcefn clone(&self) -> DesiredSensorSettings
fn clone(&self) -> DesiredSensorSettings
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for DesiredSensorSettings
impl Debug for DesiredSensorSettings
sourceimpl Default for DesiredSensorSettings
impl Default for DesiredSensorSettings
sourcefn default() -> DesiredSensorSettings
fn default() -> DesiredSensorSettings
sourceimpl Extend<DesiredSensorSettings> for DesiredSensorSettings
impl Extend<DesiredSensorSettings> for DesiredSensorSettings
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<DesiredSensorSettings> for DesiredSensorSettings
impl FromIterator<DesiredSensorSettings> for DesiredSensorSettings
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for DesiredSensorSettings
impl Hash for DesiredSensorSettings
sourceimpl LowerHex for DesiredSensorSettings
impl LowerHex for DesiredSensorSettings
sourceimpl Not for DesiredSensorSettings
impl Not for DesiredSensorSettings
type Output = DesiredSensorSettings
type Output = DesiredSensorSettings
!
operator.sourceimpl Octal for DesiredSensorSettings
impl Octal for DesiredSensorSettings
sourceimpl Ord for DesiredSensorSettings
impl Ord for DesiredSensorSettings
sourcefn cmp(&self, other: &DesiredSensorSettings) -> Ordering
fn cmp(&self, other: &DesiredSensorSettings) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialEq<DesiredSensorSettings> for DesiredSensorSettings
impl PartialEq<DesiredSensorSettings> for DesiredSensorSettings
sourcefn eq(&self, other: &DesiredSensorSettings) -> bool
fn eq(&self, other: &DesiredSensorSettings) -> bool
sourceimpl PartialOrd<DesiredSensorSettings> for DesiredSensorSettings
impl PartialOrd<DesiredSensorSettings> for DesiredSensorSettings
sourcefn partial_cmp(&self, other: &DesiredSensorSettings) -> Option<Ordering>
fn partial_cmp(&self, other: &DesiredSensorSettings) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<DesiredSensorSettings> for DesiredSensorSettings
impl Sub<DesiredSensorSettings> for DesiredSensorSettings
type Output = DesiredSensorSettings
type Output = DesiredSensorSettings
-
operator.sourceimpl SubAssign<DesiredSensorSettings> for DesiredSensorSettings
impl SubAssign<DesiredSensorSettings> for DesiredSensorSettings
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.