Enum stm32f3xx_hal::serial::Event

#[non_exhaustive]
pub enum Event {
    TransmitDataRegisterEmtpy,
    CtsInterrupt,
    TransmissionComplete,
    ReceiveDataRegisterNotEmpty,
    OverrunError,
    Idle,
    ParityError,
    NoiseError,
    FramingError,
    LinBreak,
    CharacterMatch,
    ReceiverTimeout,
}

Interrupt and status events.

All events can be cleared by Serial::clear_event or Serial::clear_events. Some events are also cleared on other conditions.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TransmitDataRegisterEmtpy

Transmit data register empty / new data can be sent.

This event is set by hardware when the content of the TDR register has been transferred into the shift register. It is cleared by Serials serial::Write::write() implementation to the TDR register.

CtsInterrupt

CTS (Clear to Send) event.

This event is set by hardware when the CTS input toggles, if the CTSE bit is set.

TransmissionComplete

Transmission complete

This event is set by hardware if the transmission of a frame containing data is complete and if TXE is set. It is cleared by Serials serial::Write::write() implementaiton to the USART_TDR register.

ReceiveDataRegisterNotEmpty

Read data register not empty / new data has been received.

This event is set by hardware when the content of the RDR shift register has been transferred to the RDR register. It is cleared by Serials serial::Read::read() to the USART_RDR register.

OverrunError

Overrun Error detected.

This event is set by hardware when the data currently being received in the shift register is ready to be transferred into the RDR register while Event::ReceiveDataRegisterNotEmpty is set.

See Error::Overrun for a more detailed description.

Idle

Idle line state detected.

This event is set by hardware when an Idle Line is detected.

ParityError

Parity error detected.

This event is set by hardware when a parity error occurs in receiver mode.

Parity can be configured by using config::Parity to create a config::Config.

NoiseError

Noise error detected.

This event is set by hardware when noise is detected on a received frame.

FramingError

Framing error detected

This event is set by hardware when a de-synchronization, excessive noise or a break character is detected.

LinBreak

LIN break

This bit is set by hardware when the LIN break is detected.

CharacterMatch

The received character matched the configured character.

The matching character can be configured with Serial::match_character()

ReceiverTimeout

Nothing was received since the last received character for Serial::receiver_timeout() amount of time.

Note

Never set for UART peripheral, which does not have ReceiverTimeoutExt implemented.

Trait Implementations

impl<O: Into<EnumSet<Event>>> BitAnd<O> for Event

type Output = EnumSet<Event>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> Self::Output

Performs the & operation.

impl<O: Into<EnumSet<Event>>> BitOr<O> for Event

type Output = EnumSet<Event>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> Self::Output

Performs the | operation.

impl<O: Into<EnumSet<Event>>> BitXor<O> for Event

type Output = EnumSet<Event>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> Self::Output

Performs the ^ operation.

impl Clone for Event

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl EnumSetTypePrivate for Event

type Repr = u16

The underlying type used to store the bitset.

const ALL_BITS: Self::Repr = {transmute(0x0fff): <serial::Event as enumset::__internal::EnumSetTypePrivate>::Repr}

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 12u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 12u32

The number of variants in the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

impl From<Error> for Event

fn from(error: Error) -> Self

Converts to this type from the input type.

impl Not for Event

type Output = EnumSet<Event>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<EnumSet<Event>> for Event

fn eq(&self, other: &EnumSet<Event>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Event

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<O: Into<EnumSet<Event>>> Sub<O> for Event

type Output = EnumSet<Event>

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self::Output

Performs the - operation.

impl TryFrom<Event> for Error

type Error = TryFromEventError

The type returned in the event of a conversion error.

fn try_from(event: Event) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Event

impl EnumSetType for Event

impl Eq for Event