Struct ably::error::Error

pub struct Error {
    pub code: ErrorCode,
    pub message: String,
    pub status_code: Option<u32>,
    pub href: String,
    pub cause: Option<Box<dyn Error + Send + Sync>>,
}

Expand description

Fields

code: ErrorCode

The Ably error code.

message: String

Additional message information, where available.

status_code: Option<u32>

HTTP Status Code corresponding to this error, where applicable.

href: String

Link to Ably documenation with more information about the error.

cause: Option<Box<dyn Error + Send + Sync>>

Underlying error

Implementations

impl Error

pub fn new<S: Into<String>>(code: ErrorCode, message: S) -> Self

Returns an Error with the given code and message.

pub fn with_status<S: Into<String>>(
    code: ErrorCode,
    status_code: u32,
    message: S
) -> Self

Returns an Error with the given code, message, and status_code.

pub fn with_cause<E, S: Into<String>>(
    code: ErrorCode,
    cause: E,
    message: S
) -> Selfwhere
    E: Error + Send + Sync + 'static,

Returns an Error with the given code, message, and cause.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Error

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for Error

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

Format the error like:

[ErrorInfo: ; statusCode=; code=; see ]

sourceimpl Error for Error

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

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

1.0.0 · sourcefn description(&self) -> &str

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

1.0.0 · sourcefn cause(&self) -> Option<&dyn Error>

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

sourcefn provide<'a>(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)Provides type based access to context intended for error reports. Read more

sourceimpl From<DecodeError> for Error

sourcefn from(err: DecodeError) -> Self

Converts to this type from the input type.

sourceimpl From<Error> for Error

sourcefn from(err: Error) -> Self

Converts to this type from the input type.

sourceimpl From<Error> for Error

sourcefn from(err: Error) -> Self

Converts to this type from the input type.

sourceimpl From<Error> for Error

sourcefn from(err: Error) -> Self

Converts to this type from the input type.

sourceimpl From<Error> for Error

sourcefn from(err: Error) -> Self

Converts to this type from the input type.

sourceimpl From<InvalidHeaderValue> for Error

sourcefn from(_: InvalidHeaderValue) -> Self

Converts to this type from the input type.

sourceimpl From<InvalidLength> for Error

sourcefn from(_: InvalidLength) -> Self

Converts to this type from the input type.

sourceimpl From<ParseError> for Error

sourcefn from(err: ParseError) -> Self

Converts to this type from the input type.

sourceimpl From<Utf8Error> for Error

sourcefn from(err: Utf8Error) -> Self

Converts to this type from the input type.

`Auto Trait Implementations`

impl !RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl !UnwindSafe for Error

`Blanket Implementations`

sourceimpl<T> Any for Twhere
    T: 'static + ?Sized,

sourcefn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

sourceimpl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · sourcefn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

sourceimpl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · sourcefn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

sourceimpl<T> From<T> for T

const: unstable · sourcefn from(t: T) -> T

Returns the argument unchanged.

sourceimpl<T> Instrument for T

sourcefn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an
Instrumented wrapper. Read more

sourcefn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an
Instrumented wrapper. Read more

sourceimpl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · sourcefn into(self) -> U

Calls U::from(self).


That is, this conversion is whatever the implementation of
From<T> for U chooses to do.

sourceimpl<E> Provider for Ewhere
    E: Error + ?Sized,

sourcefn provide<'a>(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (provide_any)Data providers should implement this method to provide all values they are able to
provide by using demand. Read more

sourceimpl<T> Same<T> for T

type Output = T

Should always be Self

sourceimpl<T> ToString for Twhere
    T: Display + ?Sized,

sourcedefault fn to_string(&self) -> String

Converts the given value to a String. Read more

sourceimpl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · sourcefn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

sourceimpl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · sourcefn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,

fn vzip(self) -> V

sourceimpl<T> WithSubscriber for T

sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
    S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more

sourcefn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more

sourceimpl<T> DeserializeOwned for Twhere
    T: for<'de> Deserialize<'de>,