Enum SourceError 

pub enum SourceError {
    Config {
        message: String,
    },
    Auth {
        message: String,
    },
    Refused {
        message: String,
    },
    RateLimited {
        retry_after_seconds: Option<u64>,
        message: Option<String>,
    },
    Unavailable {
        message: String,
    },
    Malformed {
        message: String,
    },
}

Why a source could not answer.

Every variant carries owned data only, so an error survives the JSON-over-stdio boundary a subprocess-hosted plugin crosses without losing anything.

Variants

Config

The source’s configuration block is wrong, or names something absent.

Fields

message: String

What is wrong, in a form a user can act on.

Auth

The credential was missing, malformed, or rejected.

Fields

message: String

What failed. Never contains the credential itself.

Refused

The source understood the request and declined it.

Fields

message: String

The source’s own reason.

RateLimited

The source asked the caller to slow down.

A rate limit is the one refusal whose reason an operator cannot guess from the kind alone. A hosted service typically has more than one limiter, only some of them are reported by the endpoint an operator would go and check, and the right next step differs between them — so a source that knows which one refused it, and what it was doing when it did, says so in message rather than leaving the operator to infer it and infer it wrong.

Fields

retry_after_seconds: Option<u64>

How long the source asked us to wait, when it said.

message: Option<String>

What the source can add about which limit refused it and what it was doing.

Absent means the source had nothing to add beyond the kind, which is what every source said before this member existed; it is omitted from the wire entirely when absent, so a reader written against the shape without it sees exactly the shape it was written for. Never contains a credential.

Unavailable

The source could not be reached at all.

Fields

message: String

What went wrong reaching it.

Malformed

The source answered with something this interface cannot represent.

Fields

message: String

What could not be represented.

Trait Implementations

impl Clone for SourceError

fn clone(&self) -> SourceError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourceError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SourceError

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

Formats the value using the given formatter.

impl Error for SourceError

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 JsonSchema for SourceError

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SourceError

fn eq(&self, other: &SourceError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SourceError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SourceError