Skip to main content

MessageResult

Enum MessageResult 

Source
#[non_exhaustive]
pub enum MessageResult { Delivered { response: String, }, Failed(ServerError), Refused(ServerError), NotSent { reason: String, }, }
Expand description

What became of a message you sent.

A message can fail in three different places and this crate keeps them apart, because the right response differs: a message that never left this client can be retried immediately, one the server refused will be refused again, and one the Metadata Adapter rejected is an application-level answer.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Delivered

The Metadata Adapter processed the message without raising [docs/spec/04-notifications.md §4.1].

Fields

§response: String

The adapter’s own response text, empty when it supplied none. Its meaning is entirely the application’s.

§

Failed(ServerError)

The message reached the server but was not delivered, or the Metadata Adapter failed while processing it [docs/spec/04-notifications.md §4.2].

Appendix B codes 32, 33, 38 and 39 concern the sequence numbering specifically — a progressive already used, or one skipped because the server stopped waiting for it [docs/spec/05-error-codes.md §2].

§

Refused(ServerError)

The server refused the request outright, so no delivery outcome will ever follow [docs/spec/03-requests.md §13.2].

§

NotSent

The message never reached the server.

Messages are not buffered and not resent. A subscription is a statement of desired state and is safely re-created on whatever session comes next; a message is a one-shot side effect whose ordering and deduplication the server tracks per session. Replaying one across a session replacement would restart the numbering the server deduplicates against, so this crate fails the send rather than promise an ordering it cannot keep. Whether to retry is yours to decide, because you are the only one who can decide it correctly.

Fields

§reason: String

What stopped it. Never contains a credential.

Trait Implementations§

Source§

impl Clone for MessageResult

Source§

fn clone(&self) -> MessageResult

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 MessageResult

Source§

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

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

impl Eq for MessageResult

Source§

impl PartialEq for MessageResult

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MessageResult

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

Source§

type Output = T

Should always be Self
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