Skip to main content

EngineEvent

Enum EngineEvent 

Source
pub enum EngineEvent {
    MessageReceived {
        channel_id: ChannelId,
        message_key: MessageKey,
    },
    LinkWrite,
    AckRequired {
        packet_number: PacketNumber,
    },
    Retransmit {
        packet_number: PacketNumber,
    },
    WakeAt(Instant),
    Reliability(PacketReliabilityEvent),
}
Expand description

Events emitted by the protocol engine to its embedding environment.

Variants§

§

MessageReceived

A complete message is available for a channel.

Fields

§channel_id: ChannelId

Channel that owns the message.

§message_key: MessageKey

Message identity on the channel.

§

LinkWrite

A protocol response should be written to the lower link.

§

AckRequired

An ACK response should be generated for a packet.

Fields

§packet_number: PacketNumber

Packet number that should be acknowledged.

§

Retransmit

A retransmission became due.

Fields

§packet_number: PacketNumber

Packet number selected for retransmission.

§

WakeAt(Instant)

The engine needs to be ticked again at a later instant.

§

Reliability(PacketReliabilityEvent)

A packet-level reliability event occurred.

Implementations§

Source§

impl EngineEvent

Source

pub const fn kind(self) -> EngineEventKind

Returns this event’s kind.

Trait Implementations§

Source§

impl Clone for EngineEvent

Source§

fn clone(&self) -> EngineEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EngineEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for EngineEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for EngineEvent

Source§

impl Eq for EngineEvent

Source§

impl StructuralPartialEq for EngineEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.