Struct RpcError 

pub struct RpcError {
    pub code: u32,
    pub message: String,
    pub data: Option<String>,
}

Specialized error handling for RPC methods.

Instances of this type, when thrown in a method handler, will have their message serialized and sent across the wire. The caller will receive an equivalent error on the other side.

Build-in types are included but developers may use any string, with a max length of 256 bytes.

Fields

code: u32

message: String

data: Option<String>

Implementations

impl RpcError

pub const MAX_MESSAGE_BYTES: usize = 256

pub const MAX_DATA_BYTES: usize = 15360

pub fn new(code: u32, message: String, data: Option<String>) -> Self

Creates an error object with the given code and message, plus an optional data payload.

If thrown in an RPC method handler, the error will be sent back to the caller.

Error codes 1001-1999 are reserved for built-in errors (see RpcErrorCode for their meanings).

pub fn from_proto(proto: RpcError_Proto) -> Self

pub fn to_proto(&self) -> RpcError_Proto

Trait Implementations

impl Clone for RpcError

fn clone(&self) -> RpcError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcError

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

Formats the value using the given formatter.

impl Display for RpcError

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

Formats the value using the given formatter.

impl Error for RpcError

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.