Enum LeashError 

pub enum LeashError {
    PlanBlock {
        code: String,
        message: String,
        required_plan: Option<String>,
    },
    ConnectionRequired {
        provider: String,
        message: String,
        connect_url: Option<String>,
    },
    UpgradeRequired {
        message: String,
    },
    KeyNotDeclared {
        key: String,
    },
    Unauthorized {
        message: String,
    },
    Network(Error),
    UpstreamError {
        status: u16,
        message: String,
    },
    MalformedResponse {
        message: String,
    },
}

The structured error returned by every Leash SDK call.

Variants are organised so the common branches (plan blocks, connection required, upgrades) have first-class shape — no string parsing needed. For everything else, LeashError::UpstreamError preserves the HTTP status and message; LeashError::MalformedResponse covers parse failures.

Variants

PlanBlock

HTTP 402 — the caller’s plan does not include this feature.

The required_plan is best-effort: present when the platform reports it in the response body, absent otherwise.

Fields

code: String

Stable code (UPGRADE_REQUIRED from the platform).

message: String

Human-readable message.

required_plan: Option<String>

The plan tier required to unlock this call, if reported.

ConnectionRequired

HTTP 403 — the user hasn’t connected this integration yet.

Fields

provider: String

Provider id (e.g. gmail, linear).

message: String

Human-readable message.

connect_url: Option<String>

URL the caller can use to start the OAuth flow, when supplied.

UpgradeRequired

HTTP 402 surfaced from env.get — Growth plan or above is required.

Fields

message: String

Human-readable message.

KeyNotDeclared

env.get was called for a key that isn’t declared in .env.example or doesn’t exist in any source.

Note: crate::Env::get returns Ok(None) for this case so callers can branch with if value.is_none(). This variant only fires when callers reach for the lower-level surface and want the explicit error.

Fields

key: String

The env-var name that wasn’t recognised.

Unauthorized

HTTP 401 — missing or invalid credential.

Fields

message: String

Human-readable message.

Network(Error)

Failure below the HTTP layer (DNS, refused connection, TLS, etc.).

UpstreamError

An upstream HTTP error that doesn’t map onto a more specific variant.

Fields

status: u16

HTTP status code from the platform.

message: String

Human-readable message (often pulled from the response body).

MalformedResponse

Platform returned a response we couldn’t deserialise.

Fields

message: String

Diagnostic message including the field or shape that failed.

Implementations

impl LeashError

pub fn is_plan_block(&self) -> bool

True for LeashError::PlanBlock and LeashError::UpgradeRequired.

Use this to render a single “upgrade your plan” UI without caring which surface (integration POST vs env.get) tripped the block.

pub fn is_upgrade_required(&self) -> bool

Alias of Self::is_plan_block matching the TS / Go naming.

pub fn is_connection_required(&self) -> bool

True for LeashError::ConnectionRequired.

pub fn is_unauthorized(&self) -> bool

True for LeashError::Unauthorized.

pub fn is_key_not_declared(&self) -> bool

True for LeashError::KeyNotDeclared.

pub fn is_network(&self) -> bool

True for LeashError::Network.

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

Returns the originating HTTP status code, when known.

Trait Implementations

impl Debug for LeashError

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

Formats the value using the given formatter.

impl Display for LeashError

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

Formats the value using the given formatter.

impl Error for LeashError

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 LeashError

fn from(source: Error) -> Self

Converts to this type from the input type.