Enum Error 

#[non_exhaustive]
pub enum Error {
    UnknownScope {
        name: String,
    },
    UnknownEvent {
        name: String,
    },
    UnknownHarness {
        harness: String,
    },
    UnsupportedScope {
        harness: String,
        scope: Scope,
    },
    UnknownPart {
        harness: String,
        part: String,
    },
    Unsupported {
        harness: String,
        what: String,
    },
    File {
        file: String,
        message: String,
    },
    Refused(String),
    Io {
        path: PathBuf,
        source: Error,
    },
    Internal(String),
}

Everything that can go wrong in the library. Every variant but Error::Io and Error::Internal is a refusal: install returns it before any write.

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.

UnknownScope

A scope name that is not project or user.

Fields

name: String

The name given.

UnknownEvent

A hook event name that is not one of Event’s.

Fields

name: String

The name given.

UnknownHarness

A harness id the tool does not support.

Fields

harness: String

The harness id given.

UnsupportedScope

A harness that has no files at the scope.

Fields

harness: String

The harness id.

scope: Scope

The scope given.

UnknownPart

A part name (e.g. in --without) no named harness’s profile has.

Fields

harness: String

The harness, or the harnesses named, comma-separated.

part: String

The part name given.

Unsupported

Something a harness cannot do, e.g. an answer it cannot express for an event.

Fields

harness: String

The harness id.

what: String

What it cannot do, e.g. answer deny at stop.

File

A file the library must read does not parse or has the wrong shape.

Fields

file: String

The file, as the tool shows it.

message: String

What is wrong with it.

Refused(String)

A refusal from the tool’s own ExternalPart or DeclinedStore.

Io

An I/O failure on path.

Fields

path: PathBuf

The path being operated on.

source: Error

The underlying I/O error.

Internal(String)

A bug, or an inconsistent integration or harness.

Implementations

impl Error

pub fn io(path: impl Into<PathBuf>, source: Error) -> Self

An Error::Io for path from an io::Error.

pub fn file(file: impl Into<String>, message: impl Into<String>) -> Self

An Error::File: file (as the tool shows it) and what is wrong.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.