Skip to main content

TypedEvent

Enum TypedEvent 

Source
pub enum TypedEvent {
Show 14 variants Alert(String), Bye { code: Option<ResponseCode>, text: String, }, NotificationOverflow { code: Option<String>, text: String, }, QueueOverflow { dropped_count: usize, since: Instant, }, Exists(u32), Recent(u32), Expunge(u32), Vanished { earlier: bool, uids: Vec<UidRange>, }, FetchUpdate(Box<FetchResponse>), MailboxEvent(MailboxInfo), MetadataChange {}, ServerMetadataChange {}, CapabilityChange(Vec<Capability>), Extension(Box<UntaggedResponse>),
}
Expand description

Asynchronously delivered server data.

Each variant models a distinct class of server notification. The driver task converts raw UntaggedResponses into TypedEvents and publishes them via DriverEventSink.

Variants§

§

Alert(String)

RFC 3501 §7.1 [ALERT] — informational, never dropped.

§

Bye

RFC 3501 §7.1.5 BYE — connection ending.

Fields

§text: String
§

NotificationOverflow

RFC 5465 §5.8 NOTIFICATIONOVERFLOW — NOTIFY registration cleared.

Fields

§text: String
§

QueueOverflow

Internal overflow marker. Emitted when the event queue drops events.

Fields

§dropped_count: usize
§since: Instant
§

Exists(u32)

RFC 3501 §7.3.1 EXISTS — mailbox size change.

§

Recent(u32)

RFC 3501 §7.3.2 RECENT.

§

Expunge(u32)

RFC 3501 §7.4.1 EXPUNGE — message removed (sequence form).

§

Vanished

RFC 7162 VANISHED — message removed (UID form).

Fields

§earlier: bool
§

FetchUpdate(Box<FetchResponse>)

RFC 3501 §7.4.2 FETCH — flags or other update.

§

MailboxEvent(MailboxInfo)

RFC 5465 §5 MailboxName event.

§

MetadataChange

RFC 5465 §5 MailboxMetadataChange.

§

ServerMetadataChange

RFC 5465 §5 ServerMetadataChange.

§

CapabilityChange(Vec<Capability>)

RFC 3501 §7.2.1 CAPABILITY change.

§

Extension(Box<UntaggedResponse>)

Extension or future event.

Trait Implementations§

Source§

impl Clone for TypedEvent

Source§

fn clone(&self) -> TypedEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TypedEvent

Source§

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

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

impl From<UntaggedResponse> for TypedEvent

Source§

fn from(resp: UntaggedResponse) -> Self

Convert a raw untagged response into a typed event.

Used by the driver task when routing unsolicited responses to the event sink. Handles the well-known response variants directly; everything else is wrapped in TypedEvent::Extension.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more