Struct ublox::OutProtoMask
source · pub struct OutProtoMask(/* private fields */);
Expand description
A mask describing which output protocols are active.
Each bit of this mask is used for a protocol.
Through that, multiple protocols can be defined on a single port
Used in CfgPrtSpi
and CfgPrtI2c
Implementations§
source§impl OutProtoMask
impl OutProtoMask
pub const UBLOX: Self = _
pub const NMEA: Self = _
pub const RESERVED2: Self = _
pub const RESERVED3: Self = _
pub const RESERVED4: Self = _
sourcepub const RTCM3: Self = _
pub const RTCM3: Self = _
The bitfield outRtcm3 is not supported in protocol versions less than 20
pub const RESERVED6: Self = _
pub const RESERVED7: Self = _
pub const RESERVED8: Self = _
pub const RESERVED9: Self = _
pub const RESERVED10: Self = _
pub const RESERVED11: Self = _
pub const RESERVED12: Self = _
pub const RESERVED13: Self = _
pub const RESERVED14: Self = _
pub const RESERVED15: Self = _
source§impl OutProtoMask
impl OutProtoMask
sourcepub const fn bits(&self) -> u16
pub const fn bits(&self) -> u16
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> 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 OutProtoMask
impl OutProtoMask
sourcepub const fn iter(&self) -> Iter<OutProtoMask>
pub const fn iter(&self) -> Iter<OutProtoMask>
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<OutProtoMask>
pub const fn iter_names(&self) -> IterNames<OutProtoMask>
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 OutProtoMask
impl Binary for OutProtoMask
source§impl BitAnd for OutProtoMask
impl BitAnd for OutProtoMask
source§impl BitAndAssign for OutProtoMask
impl BitAndAssign for OutProtoMask
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 OutProtoMask
impl BitOr for OutProtoMask
source§fn bitor(self, other: OutProtoMask) -> Self
fn bitor(self, other: OutProtoMask) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = OutProtoMask
type Output = OutProtoMask
|
operator.source§impl BitOrAssign for OutProtoMask
impl BitOrAssign for OutProtoMask
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 OutProtoMask
impl BitXor for OutProtoMask
source§impl BitXorAssign for OutProtoMask
impl BitXorAssign for OutProtoMask
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 Debug for OutProtoMask
impl Debug for OutProtoMask
source§impl Default for OutProtoMask
impl Default for OutProtoMask
source§fn default() -> OutProtoMask
fn default() -> OutProtoMask
source§impl Extend<OutProtoMask> for OutProtoMask
impl Extend<OutProtoMask> for OutProtoMask
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 OutProtoMask
impl Flags for OutProtoMask
source§const FLAGS: &'static [Flag<OutProtoMask>] = _
const FLAGS: &'static [Flag<OutProtoMask>] = _
source§fn from_bits_retain(bits: u16) -> OutProtoMask
fn from_bits_retain(bits: u16) -> OutProtoMask
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 FromIterator<OutProtoMask> for OutProtoMask
impl FromIterator<OutProtoMask> for OutProtoMask
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 OutProtoMask
impl IntoIterator for OutProtoMask
source§impl LowerHex for OutProtoMask
impl LowerHex for OutProtoMask
source§impl Not for OutProtoMask
impl Not for OutProtoMask
source§impl Octal for OutProtoMask
impl Octal for OutProtoMask
source§impl PublicFlags for OutProtoMask
impl PublicFlags for OutProtoMask
source§impl Serialize for OutProtoMask
impl Serialize for OutProtoMask
source§impl Sub for OutProtoMask
impl Sub for OutProtoMask
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.
§type Output = OutProtoMask
type Output = OutProtoMask
-
operator.source§impl SubAssign for OutProtoMask
impl SubAssign for OutProtoMask
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.