Struct hrpc::proto::Error

pub struct Error {
    pub identifier: String,
    pub human_message: String,
    pub more_details: Bytes,
}

Error type that will be returned by servers.

Fields

identifier: String

The identifier of this error, can be used as an i18n key.

human_message: String

A (usually english) human message for this error.

more_details: Bytes

More details about this message. Is dependent on the endpoint.

Implementations

impl Error

pub fn new_not_implemented(message: impl Into<String>) -> Self

Create a new hRPC error representing a not implemented endpoint (HrpcErrorIdentifier::NotImplemented).

pub fn new_resource_exhausted(message: impl Into<String>) -> Self

Create a new hRPC error representing resource exhaustion by a client (HrpcErrorIdentifier::ResourceExhausted).

pub fn new_internal_server_error(message: impl Into<String>) -> Self

Create a new hRPC error representing an internal server error (HrpcErrorIdentifier::InternalServerError).

pub fn new_not_found(message: impl Into<String>) -> Self

Create a new hRPC error representing a not found error (HrpcErrorIdentifier::NotFound).

pub fn with_details(self, details: impl Into<Bytes>) -> Self

Set the “more details” of this hRPC error.

pub fn with_identifier(self, identifier: impl Into<String>) -> Self

Set the “identifier” of this hRPC error.

pub fn with_message(self, message: impl Into<String>) -> Self

Set the “human message” of this hRPC error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Default for Error

fn default() -> Self

Returns the “default value” for a type.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<&'static str> for Error

fn from(msg: &'static str) -> Self

Performs the conversion.

impl From<(&'static str, &'static str)> for Error

fn from((id, msg): (&'static str, &'static str)) -> Self

Performs the conversion.

impl From<(&'static str, Box<dyn Error + Send + Sync + 'static, Global>)> for Error

fn from((id, err): (&'static str, BoxError)) -> Self

Performs the conversion.

impl From<Box<dyn Error + Send + Sync + 'static, Global>> for Error

fn from(err: BoxError) -> Self

Performs the conversion.

impl From<DecodeBodyError> for HrpcError

fn from(err: DecodeBodyError) -> Self

Performs the conversion.

impl From<Error> for HrpcError

fn from(err: WsError) -> Self

Performs the conversion.

impl From<Error> for Response<Error>

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for BoxResponse

fn from(err: Error) -> Self

Performs the conversion.

impl Message for Error

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Error