Skip to main content

RealtimeEvent

Enum RealtimeEvent

pub enum RealtimeEvent {
Show 18 variants
    Subscribed(Subscribed),
    MessageReceived(MessageReceivedEvent),
    MessageSent(MessageSentEvent),
    MessageDelivered(MessageDeliveredEvent),
    MessageOpened(MessageOpenedEvent),
    MessageBounced(MessageBouncedEvent),
    MessageComplained(MessageComplainedEvent),
    MessageRejected(MessageRejectedEvent),
    DomainVerified(DomainVerifiedEvent),
    CalendarEventCreated(CalendarEventCreatedEvent),
    CalendarEventUpdated(CalendarEventUpdatedEvent),
    CalendarEventDeleted(CalendarEventDeletedEvent),
    CalendarEventStarting(CalendarEventStartingEvent),
    CalendarEventEnding(CalendarEventEndingEvent),
    CalendarEventResponded(CalendarEventRespondedEvent),
    Other(Value),
    Binary(Vec<u8>),
    Closed,
}

Available on crate feature websockets only.

Expand description

One frame from the stream.

Variants§

Subscribed(Subscribed)

The server accepted our Subscribe filter.

MessageReceived(MessageReceivedEvent)

Mail arrived (also fires for .spam / .blocked / .unauthenticated deliveries; see MessageReceivedEvent::event_type).

MessageSent(MessageSentEvent)

The API accepted an outgoing message for delivery.

MessageDelivered(MessageDeliveredEvent)

An upstream provider accepted the message.

MessageOpened(MessageOpenedEvent)

A recipient’s client rendered the message’s tracking pixel.

MessageBounced(MessageBouncedEvent)

A recipient’s provider bounced the message.

MessageComplained(MessageComplainedEvent)

A recipient filed a spam complaint.

MessageRejected(MessageRejectedEvent)

The API refused to deliver an outgoing message.

DomainVerified(DomainVerifiedEvent)

A domain finished verifying.

CalendarEventCreated(CalendarEventCreatedEvent)

A calendar event was created.

CalendarEventUpdated(CalendarEventUpdatedEvent)

A calendar event was updated (previous holds the old state).

CalendarEventDeleted(CalendarEventDeletedEvent)

A calendar event was deleted.

CalendarEventStarting(CalendarEventStartingEvent)

A calendar event is about to start.

CalendarEventEnding(CalendarEventEndingEvent)

A calendar event is about to end.

CalendarEventResponded(CalendarEventRespondedEvent)

An attendee replied to an invite.

Other(Value)

A frame this client version doesn’t know; the raw JSON is preserved.

Binary(Vec<u8>)

A binary frame (passed through undecoded).

Closed

The server closed the connection; reconnect with Client::connect_realtime.

Trait Implementations§

impl Clone for RealtimeEvent

fn clone(&self) -> Self

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

impl Debug for RealtimeEvent

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for RealtimeEvent

impl RefUnwindSafe for RealtimeEvent

impl Send for RealtimeEvent

impl Sync for RealtimeEvent

impl Unpin for RealtimeEvent

impl UnsafeUnpin for RealtimeEvent

impl UnwindSafe for RealtimeEvent

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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