Enum rust_release_artefact::Error

pub enum Error {
    IoError(Error),
    WalkDirError(Error),
    NoArtefacts(PathBuf),
    MultipleArtefacts(PathBuf),
    UnrecognisedFormat(String),
    NoComponents,
    EmptyComponent(String),
    UnrecognisedManifestRule(String),
    WildPath(PathBuf, PathBuf),
}

All the possible errors this crate can produce.

Variants

IoError(Error)

A filesystem access or permission error.

Straight from std::io in the Rust standard library, this could be anything related to reading or writing the filesystem, including permission errors, missing files, or metadata files containing invalid UTF-8 data.

WalkDirError(Error)

A filesystem navigation error.

Straight from the walkdir crate, this error arises while interpreting artefact metadata and looking for all the files that belong to a component.

NoArtefacts(PathBuf)

The given source or stage contains no valid release artefacts.

Returned when an ExtractedArtefact is created from an archive or stage directory that does not contain release artefact metadata.

The included PathBuf is the absolute path to the directory that does not contain any artefacts.

MultipleArtefacts(PathBuf)

The given source or stage contains multiple release artefacts.

Returned when an ExtractedArtefact is created from an archive or stage directory that contains multiple sets of release artefact metadata. This is a problem because ExtractedArtefact can only represent a single artefact's metadata.

The included PathBuf is the absolute path to the directory that contains multiple sets of artefact metadata.

UnrecognisedFormat(String)

The given source or stage contains artefact metadata in an unrecognised format.

Rust's release artefacts include a marker file that describes which version of the metadata format they use. This error is returned when an ExtractedArtefact is created from an archive or stage directory that contains a marker file that mentions an unrecognised metadata format.

The included String is the content of the marker file.

NoComponents

The artefact metadata lists no components.

Returned when an ExtractedArtefact is created from an archive or stage directory whose metadata includes an empty list of components.

EmptyComponent(String)

A component contains no files.

Returned when an ExtractedArtefact is created from an archive or stage directory where a component's manifest lists no files.

The included String is the name of the problem component.

UnrecognisedManifestRule(String)

A component's manifest contains an unrecognised rule.

Returned when an ExtractedArtefact is created from an archive or stage directory where a component's manifest (which is a list of rules describing which files this component installs) includes an unrecognised rule.

The included String is the text of the unrecognised rule.

WildPath(PathBuf, PathBuf)

While scanning for files inside a component, a file was found outside that component's directory.

This should not be possible, so if it happens something has gone horribly wrong.

The included paths are the component directory being scanned, and the file that was found outside it, respectively.

Trait Implementations

impl Debug for Error

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<Error> for Error

fn from(err: Error) -> Error

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Error

Performs the conversion.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

A short description of the error.

fn cause(&self) -> Option<&Error>

The lower-level cause of this error, if any.