Enum lychee_lib::ErrorKind

source · [−]

#[non_exhaustive]
pub enum ErrorKind {
Show 26 variants
    RuntimeJoin(JoinError),
    ReadFileInput(Error, PathBuf),
    ReadStdinInput(Error),
    Utf8(Utf8Error),
    NetworkRequest(Error),
    ReadResponseBody(Error),
    BuildRequestClient(Error),
    BuildGithubClient(Error),
    GithubRequest(Error),
    InvalidGithubUrl(String),
    ParseUrl(ParseError, String),
    InvalidFilePath(Uri),
    InvalidUrlFromPath(PathBuf),
    UnreachableEmailAddress(Uri, String),
    InvalidHeader(InvalidHeaderValue),
    InvalidBase(String, String),
    InvalidUriRemap(String),
    FileNotFound(PathBuf),
    DirTraversal(Error),
    InvalidGlobPattern(PatternError),
    MissingGitHubToken,
    InsecureURL(Uri),
    Channel(SendError<InputContent>),
    InvalidUrlHost,
    InvalidURI(Uri),
    Regex(Error),
}

Expand description

Kinds of status errors Note: The error messages can change over time, so don’t match on the output

Variants (Non-exhaustive)

This enum is marked as 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.

`RuntimeJoin(JoinError)`

Error while executing a future on the Tokio runtime

`ReadFileInput(Error, PathBuf)`

Error while converting a file to an input

`ReadStdinInput(Error)`

Error while reading stdin as input

`Utf8(Utf8Error)`

Errors which can occur when attempting to interpret a sequence of u8 as a string

`NetworkRequest(Error)`

Network error while handling request

`ReadResponseBody(Error)`

Cannot read the body of the received response

`BuildRequestClient(Error)`

The network client required for making requests cannot be created

`BuildGithubClient(Error)`

The Github client required for making requests cannot be created

`GithubRequest(Error)`

Network error while using Github API

`InvalidGithubUrl(String)`

Invalid Github URL

`ParseUrl(ParseError, String)`

The given string can not be parsed into a valid URL, e-mail address, or file path

`InvalidFilePath(Uri)`

The given URI cannot be converted to a file path

`InvalidUrlFromPath(PathBuf)`

The given path cannot be converted to a URI

`UnreachableEmailAddress(Uri, String)`

The given mail address is unreachable

`InvalidHeader(InvalidHeaderValue)`

The given header could not be parsed. A possible error when converting a HeaderValue from a string or byte slice.

`InvalidBase(String, String)`

The given string can not be parsed into a valid base URL or base directory

`InvalidUriRemap(String)`

The given input can not be parsed into a valid URI remapping

`FileNotFound(PathBuf)`

The given path does not resolve to a valid file

`DirTraversal(Error)`

Error while traversing an input directory

`InvalidGlobPattern(PatternError)`

The given glob pattern is not valid

`MissingGitHubToken`

The Github API could not be called because of a missing Github token.

`InsecureURL(Uri)`

Used an insecure URI where a secure variant was reachable

`Channel(SendError<InputContent>)`

Error while sending/receiving messages from MPSC channel

`InvalidUrlHost`

An URL with an invalid host was found

`InvalidURI(Uri)`

Cannot parse the given URI

`Regex(Error)`

Regex error

Implementations

source

impl ErrorKind

source

pub fn details(&self) -> Option<String>

Return more details from the given ErrorKind

What additional information we can extract depends on the underlying request type. The output is purely meant for humans (e.g. for status messages) and future changes are expected.