Struct ClientError 

pub struct ClientError { /* private fields */ }

Client error type for all XRPC client operations

Implementations

impl ClientError

pub fn new(kind: ClientErrorKind, source: Option<BoxError>) -> Self

Create a new error with the given kind and optional source

pub fn kind(&self) -> &ClientErrorKind

Get the error kind

pub fn source_err(&self) -> Option<&BoxError>

Get the source error if present

pub fn context(&self) -> Option<&str>

Get the context string if present

pub fn url(&self) -> Option<&str>

Get the URL if present

pub fn details(&self) -> Option<&str>

Get the details if present

pub fn location(&self) -> Option<&str>

Get the location if present

pub fn with_help(self, help: impl Into<SmolStr>) -> Self

Add help text to this error

pub fn with_context(self, context: impl Into<SmolStr>) -> Self

Add context to this error

pub fn with_url(self, url: impl Into<SmolStr>) -> Self

Add URL to this error

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

Add details to this error

pub fn with_location(self, location: impl Into<SmolStr>) -> Self

Add location to this error

pub fn transport(source: impl Error + Send + Sync + 'static) -> Self

Create a transport error

pub fn invalid_request(msg: impl Into<SmolStr>) -> Self

Create an invalid request error

pub fn encode(msg: impl Into<SmolStr>) -> Self

Create an encode error

pub fn decode(msg: impl Into<SmolStr>) -> Self

Create a decode error

pub fn http(status: StatusCode, body: Option<Bytes>) -> Self

Create an HTTP error with status code and optional body

pub fn auth(auth_error: AuthError) -> Self

Create an authentication error

pub fn identity_resolution(source: impl Error + Send + Sync + 'static) -> Self

Create an identity resolution error

pub fn storage(source: impl Error + Send + Sync + 'static) -> Self

Create a storage error

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Diagnostic for ClientError

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn diagnostic_source<'a>(&'a self) -> Option<&'a dyn Diagnostic>

The cause of the error.

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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 From<AuthError> for ClientError

fn from(e: AuthError) -> Self

Converts to this type from the input type.

impl From<DecodeError<Error>> for ClientError

fn from(e: DecodeError<Error>) -> Self

Converts to this type from the input type.

impl From<DecodeError<HttpError>> for ClientError

fn from(e: DecodeError<HttpError>) -> Self

Converts to this type from the input type.

impl From<DecodeError<Infallible>> for ClientError

fn from(e: DecodeError<Infallible>) -> Self

Converts to this type from the input type.

impl From<DecodeError> for ClientError

fn from(e: DecodeError) -> Self

Converts to this type from the input type.

impl From<EncodeError> for ClientError

fn from(e: EncodeError) -> Self

Converts to this type from the input type.

impl From<Error<Error>> for ClientError

Available on crate feature websocket only.

fn from(e: Error<Error>) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

Available on crate feature reqwest-client only.

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<HttpError> for ClientError

fn from(e: HttpError) -> Self

Converts to this type from the input type.

impl From<ParseError> for ClientError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<SessionStoreError> for ClientError

fn from(e: SessionStoreError) -> Self

Converts to this type from the input type.