Struct TypedError 

pub struct TypedError<E>(pub E);

Available on crate feature ws only.

A handler error which reaches the client as a typed value.

The wrapped error is encoded in the body format of the connection, and the client decodes it back with web::Error::server_error (or client::Error::server_error). Its fmt::Display text is sent along as the message of the error, which is what a client that does not decode the payload sees. See Errors for an example.

If the error cannot be encoded the client receives the message alone, as if it was a plain text error.

This deliberately does not implement fmt::Display itself, since that would make it a text error. Use TypedError::get or the public field to get at the error.

Examples

use musli_web::ws::TypedError;

fn check(value: u32) -> Result<u32, TypedError<String>> {
    if value == 0 {
        // Converted with `From` by the question mark operator.
        Err::<(), _>(String::from("Zero is not allowed"))?;
    }

    Ok(value)
}

let error = check(0).unwrap_err();
assert_eq!(error.get(), "Zero is not allowed");

Tuple Fields

0: E

Implementations

impl<E> TypedError<E>

pub const fn new(error: E) -> Self

Wrap an error.

Examples

use musli_web::ws::TypedError;

let error = TypedError::new(42u32);
assert_eq!(error.into_inner(), 42);

pub const fn get(&self) -> &E

Get a reference to the wrapped error.

pub fn into_inner(self) -> E

Unwrap the error.

Trait Implementations

impl<E: Clone> Clone for TypedError<E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for TypedError<E>

impl<E: Debug> Debug for TypedError<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for TypedError<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Eq> Eq for TypedError<E>

impl<E> From<E> for TypedError<E>

fn from(error: E) -> Self

Converts to this type from the input type.

impl<E: Hash> Hash for TypedError<E>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E: PartialEq> PartialEq for TypedError<E>

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

Equality operator ==.

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

Inequality operator !=.

impl<E> ResponseError for TypedError<E>

where E: 'static + Send + Display + EncodeBody,

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

Write the human readable message of the error.

fn encode_payload(&self, payload: ErrorPayload<'_>) -> Result<(), Error>

Encode the typed payload of the error, if it has one, by calling ErrorPayload::encode.

impl<E: PartialEq> StructuralPartialEq for TypedError<E>