Enum UnifiError 

#[non_exhaustive]
pub enum UnifiError {
    MissingUrl,
    MissingApiKey,
    ClientBuild(Error),
    Timeout {
        method: String,
        url: String,
        source: Error,
    },
    Connect {
        method: String,
        url: String,
        source: Error,
    },
    Request {
        method: String,
        url: String,
        source: Error,
    },
    Unauthorized(String),
    Forbidden {
        method: String,
        url: String,
    },
    NotFound {
        method: String,
        url: String,
    },
    RateLimited {
        method: String,
        url: String,
        retry_after: Option<Duration>,
    },
    EmptyBody {
        method: String,
        url: String,
    },
    Decode {
        url: String,
        source: Error,
    },
    UnexpectedStatus {
        status: u16,
        url: String,
        body: Box<Value>,
    },
    UnknownAction(String),
    InvalidRequest {
        context: String,
        message: String,
    },
    PathTemplate(String),
    ConnectorPath(String),
    HybridRouting(String),
}

Everything that can go wrong talking to a UniFi controller.

Marked #[non_exhaustive]: this crate is meant to be published and consumed externally, so a caller that matches on this must include a wildcard arm — adding a new variant (e.g. a future status-class split) must never be a semver-breaking change for downstream code.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingUrl

UnifiConfig::url was empty.

MissingApiKey

UnifiConfig::api_key was empty.

ClientBuild(Error)

The underlying reqwest::Client failed to build.

Timeout

The request exceeded the client timeout.

Fields

method: String

HTTP method of the request that timed out.

url: String

Full request URL.

source: Error

Underlying transport error (kept for Error::source() chain-walking even though the message above doesn’t repeat its text).

Connect

The controller could not be reached (DNS, TCP, or TLS handshake failure).

Fields

method: String

HTTP method of the request that failed to connect.

url: String

Full request URL.

source: Error

Underlying transport error (kept for Error::source() chain-walking even though the message above doesn’t repeat its text).

Request

A transport-level failure other than timeout or connect.

Fields

method: String

HTTP method of the failed request.

url: String

Full request URL.

source: Error

Underlying transport error.

Unauthorized(String)

The controller rejected the API key (HTTP 401). Unlike the other status-class variants this has no method field: a rejected key is rejected the same way for every verb, so there’s nothing extra to carry — not an oversight.

Tuple Fields

0: String

Full request URL.

Forbidden

The API key is valid but lacks permission for the request (HTTP 403).

Fields

method: String

HTTP method of the forbidden request.

url: String

Full request URL.

NotFound

The controller has no such endpoint (HTTP 404).

Fields

method: String

HTTP method of the request.

url: String

Full request URL.

RateLimited

The controller rejected the request for exceeding its rate limit (HTTP 429).

Fields

method: String

HTTP method of the rate-limited request.

url: String

Full request URL.

retry_after: Option<Duration>

Parsed Retry-After response header, when present and expressed in seconds (the HTTP-date form is not parsed).

EmptyBody

A GET returned a successful status with no body, where a JSON body was expected.

Fields

method: String

HTTP method of the request.

url: String

Full request URL.

Decode

The response body was not valid JSON.

Fields

url: String

Full request URL.

source: Error

Underlying JSON parse error.

UnexpectedStatus

The controller returned a non-success status not covered by a more specific variant.

Fields

status: u16

HTTP status code.

url: String

Full request URL.

body: Box<Value>

Response body, if any was returned.

UnknownAction(String)

crate::ActionDispatcher::execute was asked to run an action that has no registered crate::capabilities::Capability.

InvalidRequest

A request’s parameters were malformed (wrong type, wrong API family, unknown hybrid target, etc). context is an action name or an HTTP method + path, whichever the caller had on hand.

Fields

context: String

What was being executed when validation failed.

message: String

What was wrong with the request.

PathTemplate(String)

Path-template substitution failed (unmatched brace, missing parameter, wrong type).

ConnectorPath(String)

The *path connector wildcard segment failed validation (traversal, encoded separators, or outside the allowed API prefixes).

HybridRouting(String)

Hybrid action routing (official vs. internal) failed.

Trait Implementations

impl Debug for UnifiError

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

Formats the value using the given formatter.

impl Display for UnifiError

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

Formats the value using the given formatter.

impl Error for UnifiError

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.