Struct ublox::InProtoMask
source · [−]pub struct InProtoMask { /* private fields */ }
Expand description
A mask describing which input 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
sourceimpl InProtoMask
impl InProtoMask
pub const UBOX: Self = Self{bits: 1 as u16,}
pub const NMEA: Self = Self{bits: (1 as u16) << 1u32,}
pub const RTCM: Self = Self{bits: (1 as u16) << 2u32,}
pub const RESERVED3: Self = Self{bits: (1 as u16) << 3u32,}
pub const RESERVED4: Self = Self{bits: (1 as u16) << 4u32,}
sourcepub const RTCM3: Self = Self{bits: (1 as u16) << 5u32,}
pub const RTCM3: Self = Self{bits: (1 as u16) << 5u32,}
The bitfield inRtcm3 is not supported in protocol versions less than 20
pub const RESERVED6: Self = Self{bits: (1 as u16) << 6u32,}
pub const RESERVED7: Self = Self{bits: (1 as u16) << 7u32,}
pub const RESERVED8: Self = Self{bits: (1 as u16) << 8u32,}
pub const RESERVED9: Self = Self{bits: (1 as u16) << 9u32,}
pub const RESERVED10: Self = Self{bits: (1 as u16) << 10u32,}
pub const RESERVED11: Self = Self{bits: (1 as u16) << 11u32,}
pub const RESERVED12: Self = Self{bits: (1 as u16) << 12u32,}
pub const RESERVED13: Self = Self{bits: (1 as u16) << 13u32,}
pub const RESERVED14: Self = Self{bits: (1 as u16) << 14u32,}
pub const RESERVED15: Self = Self{bits: (1 as u16) << 15u32,}
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 InProtoMask
impl Binary for InProtoMask
sourceimpl BitAnd<InProtoMask> for InProtoMask
impl BitAnd<InProtoMask> for InProtoMask
type Output = InProtoMask
type Output = InProtoMask
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<InProtoMask> for InProtoMask
impl BitAndAssign<InProtoMask> for InProtoMask
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<InProtoMask> for InProtoMask
impl BitOr<InProtoMask> for InProtoMask
sourcefn bitor(self, other: InProtoMask) -> Self
fn bitor(self, other: InProtoMask) -> Self
Returns the union of the two sets of flags.
type Output = InProtoMask
type Output = InProtoMask
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<InProtoMask> for InProtoMask
impl BitOrAssign<InProtoMask> for InProtoMask
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<InProtoMask> for InProtoMask
impl BitXor<InProtoMask> for InProtoMask
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 = InProtoMask
type Output = InProtoMask
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<InProtoMask> for InProtoMask
impl BitXorAssign<InProtoMask> for InProtoMask
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for InProtoMask
impl Clone for InProtoMask
sourcefn clone(&self) -> InProtoMask
fn clone(&self) -> InProtoMask
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 InProtoMask
impl Debug for InProtoMask
sourceimpl Default for InProtoMask
impl Default for InProtoMask
sourcefn default() -> InProtoMask
fn default() -> InProtoMask
Returns the “default value” for a type. Read more
sourceimpl Extend<InProtoMask> for InProtoMask
impl Extend<InProtoMask> for InProtoMask
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<InProtoMask> for InProtoMask
impl FromIterator<InProtoMask> for InProtoMask
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 InProtoMask
impl Hash for InProtoMask
sourceimpl LowerHex for InProtoMask
impl LowerHex for InProtoMask
sourceimpl Not for InProtoMask
impl Not for InProtoMask
type Output = InProtoMask
type Output = InProtoMask
The resulting type after applying the !
operator.
sourceimpl Octal for InProtoMask
impl Octal for InProtoMask
sourceimpl Ord for InProtoMask
impl Ord for InProtoMask
sourceimpl PartialEq<InProtoMask> for InProtoMask
impl PartialEq<InProtoMask> for InProtoMask
sourcefn eq(&self, other: &InProtoMask) -> bool
fn eq(&self, other: &InProtoMask) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &InProtoMask) -> bool
fn ne(&self, other: &InProtoMask) -> bool
This method tests for !=
.
sourceimpl PartialOrd<InProtoMask> for InProtoMask
impl PartialOrd<InProtoMask> for InProtoMask
sourcefn partial_cmp(&self, other: &InProtoMask) -> Option<Ordering>
fn partial_cmp(&self, other: &InProtoMask) -> 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<InProtoMask> for InProtoMask
impl Sub<InProtoMask> for InProtoMask
type Output = InProtoMask
type Output = InProtoMask
The resulting type after applying the -
operator.
sourceimpl SubAssign<InProtoMask> for InProtoMask
impl SubAssign<InProtoMask> for InProtoMask
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for InProtoMask
impl UpperHex for InProtoMask
impl Copy for InProtoMask
impl Eq for InProtoMask
impl StructuralEq for InProtoMask
impl StructuralPartialEq for InProtoMask
Auto Trait Implementations
impl RefUnwindSafe for InProtoMask
impl Send for InProtoMask
impl Sync for InProtoMask
impl Unpin for InProtoMask
impl UnwindSafe for InProtoMask
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
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more