pub struct Status { /* private fields */ }
Expand description
Status flags.
Implementations§
source§impl Status
impl Status
sourcepub const RECEIVE_ACTIVE: Self = _
pub const RECEIVE_ACTIVE: Self = _
Receiver active flag.
Set when the receiver detects a start bit. Cleared when the line is idle.
sourcepub const TRANSMIT_EMPTY: Self = _
pub const TRANSMIT_EMPTY: Self = _
Transmit data register empty.
This bit is set when the transmit FIFO can accept data.
- if the FIFO is enabled, this is set when the FIFO hits the watermark.
- if the FIFO is disabled, this is set when there’s nothing in the transmit data register.
sourcepub const TRANSMIT_COMPLETE: Self = _
pub const TRANSMIT_COMPLETE: Self = _
Transmit complete.
TC is cleared when there’s a transmission in progress, or when a preamble / break character is loaded. It’s set when the transmit buffer is empty.
To clear TC, perform a write.
sourcepub const RECEIVE_FULL: Self = _
pub const RECEIVE_FULL: Self = _
Receiver data register full.
This bit is set when the receive FIFO is full.
- if the FIFO is enabled, this is set when the FIFO hits the watermark.
- if the FIFO is disabled, this is set when there’s something in the receiver register.
sourcepub const IDLE: Self = _
pub const IDLE: Self = _
Idle line flag.
IDLE is set when the LPUART receive line becomes idle for a full character time after a period of activity.
sourcepub const OVERRUN: Self = _
pub const OVERRUN: Self = _
Receiver overrun.
Set when software fails to prevent the receive data register from overflowing with data. The OR bit is set immediately after the stop bit has been completely received for the dataword that overflows the buffer and all the other error flags (FE, NF, and PF) are prevented from setting.
sourcepub const NOISY: Self = _
pub const NOISY: Self = _
Noise flag.
This is also available in the read flags. However, setting it here allows you to clear the noise flag in the status register.
sourcepub const FRAME_ERROR: Self = _
pub const FRAME_ERROR: Self = _
Framing error.
This is also available in the read flags. However, setting it here allows you to clear the noise flag in the status register.
sourcepub const PARITY_ERROR: Self = _
pub const PARITY_ERROR: Self = _
Parity error.
This is also available in the read flags. However, setting it here allows you to clear the noise flag in the status register.
sourcepub const TRANSMIT_OVERFLOW: Self = _
pub const TRANSMIT_OVERFLOW: Self = _
Transmitter Buffer Overflow Flag
Indicates that more data has been written to the transmit buffer than it can hold.
sourcepub const RECEIVE_UNDERFLOW: Self = _
pub const RECEIVE_UNDERFLOW: Self = _
Receiver Buffer Underflow Flag
Indicates that more data has been read from the receive buffer than was present.
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.