Enum RestClientError 

pub enum RestClientError {
    DiffError(DiffError),
    MalformedEventInfo(String),
    Request(Error),
    RequestContext {
        task: String,
        source: Error,
    },
    Io {
        task: String,
        source: Error,
    },
    GitCommand(String),
    RateLimitNoReset,
    RateLimitPrimary(DateTime<Utc>),
    RateLimitSecondary,
    CannotCloneRequest,
    InvalidHeaderValue(InvalidHeaderValue),
    UnexpectedHeaderValue(ToStrError),
    HeaderParseInt(ParseIntError),
    UrlParse(ParseError),
    Json {
        task: String,
        source: Error,
    },
    EnvVar {
        name: String,
        source: VarError,
    },
    OutputVar(OutputVariableError),
}

The possible error emitted by the REST client API

Variants

DiffError(DiffError)

Available on crate feature file-changes only.

Errors related to parsing git diffs.

MalformedEventInfo(String)

Error emitted when encountering malformed event information.

Request(Error)

Error related to making HTTP requests

RequestContext

Error related to making HTTP requests, with additional context about the request that caused the error.

Fields

task: String

The task being attempted.

source: Error

The original error being propagated.

Io

Errors related to standard I/O.

Fields

task: String

The task being attempted.

source: Error

The original error being propagated.

GitCommand(String)

Available on crate feature file-changes only.

Error related to git command execution.

RateLimitNoReset

Error related to exceeding REST API Rate limits and no reset time is provided in the response headers.

RateLimitPrimary(DateTime<Utc>)

Error related to exceeding REST API Rate limits with a known reset time.

RateLimitSecondary

Error related to exhausting all retries after hitting REST API Rate limits.

CannotCloneRequest

Error emitted when failing to clone a request object.

InvalidHeaderValue(InvalidHeaderValue)

Error emitted when failing to create a header value.

UnexpectedHeaderValue(ToStrError)

Error emitted when failing to convert a header value to string.

HeaderParseInt(ParseIntError)

Error emitted when failing to parse an integer from a header value (as a UTF-8 string).

UrlParse(ParseError)

Error emitted when failing to parse a URL.

Json

Error emitted when failing to deserialize/serialize request/response JSON data.

Fields

task: String

The task being attempted.

source: Error

The original error being propagated.

EnvVar

Error emitted when failing to read an environment variable.

Fields

name: String

The name of the environment variable that was attempted to be read.

source: VarError

The original error being propagated.

OutputVar(OutputVariableError)

An error emitted when encountering an invalid OutputVariable.

Implementations

impl RestClientError

pub fn env_var(name: &str, source: VarError) -> Self

Helper function to create an Self::EnvVar error with variable name and source error.

pub fn io(task: &str, source: Error) -> Self

Helper function to create an Self::Io error with task context.

pub fn add_request_context(self, task: &str) -> Self

Builder function to add context to Self::Request errors.

Returns a Self::RequestContext error if self is a Self::Request error. Otherwise, returns self unchanged.

pub fn json(task: &str, source: Error) -> Self

Helper function to create a Self::Json error with task context.

Trait Implementations

impl Debug for RestClientError

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

Formats the value using the given formatter.

impl Display for RestClientError

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

Formats the value using the given formatter.

impl Error for RestClientError

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<DiffError> for RestClientError

fn from(source: DiffError) -> Self

Converts to this type from the input type.

impl From<Error> for RestClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for RestClientError

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<OutputVariableError> for RestClientError

fn from(source: OutputVariableError) -> Self

Converts to this type from the input type.

impl From<ParseError> for RestClientError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for RestClientError

fn from(source: ParseIntError) -> Self

Converts to this type from the input type.

impl From<ToStrError> for RestClientError

fn from(source: ToStrError) -> Self

Converts to this type from the input type.