Enum PulseError 

pub enum PulseError {
    Auth {
        path: String,
        body: Option<Value>,
    },
    NotFound {
        path: String,
        body: Option<Value>,
    },
    Validation {
        path: String,
        body: Option<Value>,
    },
    RateLimit {
        path: String,
        body: Option<Value>,
        retry_after_seconds: Option<u32>,
    },
    Api {
        status: u16,
        path: String,
        body: Option<Value>,
    },
    Transport(Error),
    Json(Error),
    NoToken {
        path: String,
    },
    InvalidConfig(String),
}

The single error type returned by every PulseClient method.

Variants

Auth

401 — invalid / missing / expired JWT.

Fields

path: String

body: Option<Value>

NotFound

404 — the resource does not exist.

Fields

path: String

body: Option<Value>

Validation

400 — the request body is malformed.

Fields

path: String

body: Option<Value>

RateLimit

429 — per-user or per-IP rate limit hit. Carries the server’s advised wait time, parsed from either the retryAfterSeconds JSON field or the Retry-After HTTP header. None means the server gave no hint.

Fields

path: String

body: Option<Value>

retry_after_seconds: Option<u32>

Api

Any other non-2xx status code (5xx, unexpected 4xx).

Fields

status: u16

path: String

body: Option<Value>

Transport(Error)

The HTTP transport itself failed (connection refused, timeout, DNS, TLS handshake, etc.). Wraps the underlying reqwest error.

Json(Error)

JSON serialisation / deserialisation failure. The wire format the server returned doesn’t match what the client expected.

NoToken

The caller invoked an authenticated endpoint without setting a token first. Surfaces before any network call, so it has no body.

Fields

path: String

InvalidConfig(String)

The supplied configuration is invalid (e.g. empty base_url).

Implementations

impl PulseError

pub fn is_auth_error(&self) -> bool

pub fn is_not_found(&self) -> bool

pub fn is_validation_error(&self) -> bool

pub fn is_rate_limited(&self) -> bool

pub fn status_code(&self) -> Option<u16>

HTTP status code, if the error carries one. None for transport / JSON / no-token / config errors.

pub fn body(&self) -> Option<&Value>

The parsed JSON error body the server returned, if any.

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

Trait Implementations

impl Debug for PulseError

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

Formats the value using the given formatter.

impl Display for PulseError

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

Formats the value using the given formatter.

impl Error for PulseError

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<Error> for PulseError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for PulseError

fn from(e: Error) -> Self

Converts to this type from the input type.