Enum InventoryError 

pub enum InventoryError {
    RateLimited(RateLimited),
    Cancelled,
    Github(GithubError),
}

Everything an inventory read can fail with.

GithubError is carried through rather than flattened, because c2’s taxonomy already separates the three outcomes f1 branches on — a rejected credential, an authentication lockout, and a permissions refusal — and re-deciding that here would give the product two answers to the same question. The two variants added in front of it are the ones c2 explicitly left to this layer.

Variants

RateLimited(RateLimited)

GitHub is refusing further requests for now. Resolves by waiting.

Cancelled

The caller withdrew the request. Nothing is known about the target.

Github(GithubError)

Implementations

impl InventoryError

pub fn is_rate_limited(&self) -> bool

pub fn is_cancelled(&self) -> bool

pub fn rate_limited(&self) -> Option<&RateLimited>

The rate limit behind this failure, when there is one.

pub fn is_offline(&self) -> bool

true when GitHub could not be reached at all, as opposed to answering something unwelcome. e1’s offline handling turns on this distinction: an outage retains running runners, while a rejection does not.

Trait Implementations

impl Debug for InventoryError

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

Formats the value using the given formatter.

impl Display for InventoryError

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

Formats the value using the given formatter.

impl Error for InventoryError

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<GithubError> for InventoryError

fn from(source: GithubError) -> Self

Converts to this type from the input type.