Enum PredefinedResponseError

#[non_exhaustive]
pub enum PredefinedResponseError {
    Unhandled,
    Aborted,
    ParseFailed(Cow<'static, str>),
    NotifyHandler,
    Internal(i32),
    InternalDetailed(i32, String),
}

Some predefined reponse error types. Most of them are automatically generated from the server.

In default, errors are serialized as following form:

{
    "code": "PARSE_FAILED",
    "detail": "Failed to parse argument. (hint: Type 'i32' is expected)"
}

The encoded error types may be customized by Codec::encode_response_predefined.

Variants (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.

Unhandled

You should not use this error type directly. This error type is used internally by the library when the request object is dropped before sending request. To specify intentional abort, use PredefinedResponseError::Aborted instead.

Aborted

Use this when you want to abort the request intentionally.

ParseFailed(Cow<'static, str>)

The typename will be obtained from std::any::type_name

NotifyHandler

Invalid request/notify handler type

Internal(i32)

Internal error. This is only generated by the user.

InternalDetailed(i32, String)

Internal error. This is only generated by the user.

Implementations

impl PredefinedResponseError

pub fn is_unhandled(&self) -> bool

Returns true if this is a PredefinedResponseError::Unhandled, otherwise false

pub fn is_aborted(&self) -> bool

Returns true if this is a PredefinedResponseError::Aborted, otherwise false

pub fn is_parse_failed(&self) -> bool

Returns true if this is a PredefinedResponseError::ParseFailed, otherwise false

pub fn as_parse_failed_mut(&mut self) -> Option<&mut Cow<'static, str>>

Optionally returns mutable references to the inner fields if this is a PredefinedResponseError::ParseFailed, otherwise None

pub fn as_parse_failed(&self) -> Option<&Cow<'static, str>>

Optionally returns references to the inner fields if this is a PredefinedResponseError::ParseFailed, otherwise None

pub fn into_parse_failed(self) -> Result<Cow<'static, str>, Self>

Returns the inner fields if this is a PredefinedResponseError::ParseFailed, otherwise returns back the enum in the Err case of the result

pub fn is_notify_handler(&self) -> bool

Returns true if this is a PredefinedResponseError::NotifyHandler, otherwise false

pub fn is_internal(&self) -> bool

Returns true if this is a PredefinedResponseError::Internal, otherwise false

pub fn as_internal_mut(&mut self) -> Option<&mut i32>

Optionally returns mutable references to the inner fields if this is a PredefinedResponseError::Internal, otherwise None

pub fn as_internal(&self) -> Option<&i32>

Optionally returns references to the inner fields if this is a PredefinedResponseError::Internal, otherwise None

pub fn into_internal(self) -> Result<i32, Self>

Returns the inner fields if this is a PredefinedResponseError::Internal, otherwise returns back the enum in the Err case of the result

pub fn is_internal_detailed(&self) -> bool

Returns true if this is a PredefinedResponseError::InternalDetailed, otherwise false

pub fn as_internal_detailed_mut(&mut self) -> Option<(&mut i32, &mut String)>

Optionally returns mutable references to the inner fields if this is a PredefinedResponseError::InternalDetailed, otherwise None

pub fn as_internal_detailed(&self) -> Option<(&i32, &String)>

Optionally returns references to the inner fields if this is a PredefinedResponseError::InternalDetailed, otherwise None

pub fn into_internal_detailed(self) -> Result<(i32, String), Self>

Returns the inner fields if this is a PredefinedResponseError::InternalDetailed, otherwise returns back the enum in the Err case of the result

Trait Implementations

impl Debug for PredefinedResponseError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PredefinedResponseError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PredefinedResponseError

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

Formats the value using the given formatter.

impl Error for PredefinedResponseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Serialize for PredefinedResponseError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.