pub struct Status { /* private fields */ }
Expand description
Status flags for the LPSPI interface.
Implementations§
source§impl Status
impl Status
sourcepub const DATA_MATCH: Self = _
pub const DATA_MATCH: Self = _
Data match flag.
Indicates that received data has matched one or both of the match fields. To clear this flag, write this bit to the status register (W1C).
sourcepub const RECEIVE_ERROR: Self = _
pub const RECEIVE_ERROR: Self = _
Receive error flag.
Set when the receive FIFO has overflowed. Before clearing this bit, empty the receive FIFO. Then, write this bit to clear the flag (W1C).
sourcepub const TRANSMIT_ERROR: Self = _
pub const TRANSMIT_ERROR: Self = _
Transmit error flag.
Set when the transmit FIFO has underruns. Before clearing this bit, end the transfer. Then, write this bit to clear the flag (W1C).
sourcepub const TRANSFER_COMPLETE: Self = _
pub const TRANSFER_COMPLETE: Self = _
Transfer complete flag.
Set when the LPSPI returns to an idle state, and the transmit FIFO is empty. To clear this flag, write this bit (W1C).
sourcepub const FRAME_COMPLETE: Self = _
pub const FRAME_COMPLETE: Self = _
Frame complete flag.
Set at the end of each frame transfer, when PCS negates. To clear this flag, write this bit (W1C).
sourcepub const WORD_COMPLETE: Self = _
pub const WORD_COMPLETE: Self = _
Word complete flag.
Set when the last bit of a received word is sampled. To clear this flag, write this bit (W1C).
sourcepub const RECEIVE_DATA: Self = _
pub const RECEIVE_DATA: Self = _
Receive data flag.
Set when the number of words in the receive FIFO is greater than the watermark. This flag is read only. To clear the flag, exhaust the receive FIFO.
sourcepub const TRANSMIT_DATA: Self = _
pub const TRANSMIT_DATA: Self = _
Transmit data flag.
Set when the number of words in the transmit FIFO is less than or equal to the watermark. This flag is read only. TO clear the flag, fill the transmit FIFO.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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§
source§impl BitAndAssign for Status
impl BitAndAssign for Status
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign for Status
impl BitOrAssign for Status
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign for Status
impl BitXorAssign for Status
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<Status> for Status
impl Extend<Status> for Status
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<Status> for Status
impl FromIterator<Status> for Status
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for Status
impl Ord for Status
source§impl PartialEq for Status
impl PartialEq for Status
source§impl PartialOrd for Status
impl PartialOrd for Status
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign for Status
impl SubAssign for Status
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.