Struct nakadion::api::NakadiApiError

pub struct NakadiApiError { /* fields omitted */ }

An error type to get insights on why an HTTP request failed

Implementations

impl NakadiApiError

pub fn http<T: Into<StatusCode>>(status: T) -> Self

Create an response based error from a StatusCode received from a server

pub fn io() -> Self

Create an io based error.

pub fn other() -> Self

Create an error for some other cause

pub fn http_problem<T: Into<HttpApiProblem>>(prob: T) -> Self

Create an error from an HttpApiProblem.

Keep in mind that an HttpApiProblem can also be created from a StatusCode but in that case you should prefer NakadiApiError::http.

This will also set the HttpApiProblem as the cause for this error.

pub fn caused_by<E>(self, err: E) -> Self where
    E: StdError + Send + Sync + 'static, 

Add a cause to this error

pub fn with_context<T: Into<String>>(self, context: T) -> Self

Add a message that adds context to the cause for this error.

pub fn with_flow_id<T: Into<FlowId>>(self, flow_id: T) -> Self

Add a FlowId to this error

pub fn with_maybe_flow_id(self, flow_id: Option<FlowId>) -> Self

pub fn flow_id(&self) -> Option<&FlowId>

Returns the FlowId associated with this error

pub fn problem(&self) -> Option<&HttpApiProblem>

Returns the HttpApiProblem associated with this error if the cause of this error was an HttpApiProblem

If the cause was not an HttpApiProblem None is returned.

pub fn try_into_problem(self) -> Result<HttpApiProblem, Self>

Try to turn this error into an HttpApiProblem.

If the cause was not an HttpApiProblem Self is returned as an error.

pub fn status(&self) -> Option<StatusCode>

Get the HttpStatusCode for this error if there is a status code associated with this error

pub fn is_client_error(&self) -> bool

Returns true if there is a StatusCode and if it is a client error.

pub fn is_auth_error(&self) -> bool

Returns true if there is a StatusCode and if it StatusCode::FORBIDDEN or StatusCode::UNAUTHORIZED.

pub fn is_server_error(&self) -> bool

Returns true if there is a StatusCode and if it is a server error.

pub fn is_other_error(&self) -> bool

Returns true if the error was created with NakadiApiError::other.

pub fn is_io_error(&self) -> bool

Returns true if the error was created with NakadiApiError::io.

Trait Implementations

impl Debug for NakadiApiError

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

Formats the value using the given formatter.

impl Display for NakadiApiError

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

Formats the value using the given formatter.

impl Error for NakadiApiError

fn source(&self) -> Option<&(dyn StdError + '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<Elapsed> for NakadiApiError

fn from(err: Elapsed) -> Self

Performs the conversion.

impl From<Error> for NakadiApiError

fn from(err: Error) -> Self

Performs the conversion.

impl From<InvalidHeaderValue> for NakadiApiError

fn from(err: InvalidHeaderValue) -> Self

Performs the conversion.

impl From<InvalidUri> for NakadiApiError

fn from(err: InvalidUri) -> Self

Performs the conversion.

impl From<IoError> for NakadiApiError

fn from(err: IoError) -> Self

Performs the conversion.

impl From<NakadiApiError> for Error

fn from(err: NakadiApiError) -> Self

Performs the conversion.

impl From<NakadiApiError> for PublishError

fn from(api_error: NakadiApiError) -> Self

Performs the conversion.

impl From<NakadiApiError> for CommitError

fn from(api_error: NakadiApiError) -> Self

Performs the conversion.

impl From<NakadiApiError> for ConnectError

fn from(api_error: NakadiApiError) -> Self

Performs the conversion.

impl From<RemoteCallError> for NakadiApiError

fn from(err: RemoteCallError) -> Self

Performs the conversion.

impl From<TokenError> for NakadiApiError

fn from(err: TokenError) -> Self

Performs the conversion.