Enum ArchiveEvent

#[non_exhaustive]
pub enum ArchiveEvent<'a> {
    ArchiveStarted {
        counts: ArchiveCounts,
        output_file: &'a Utf8Path,
    },
    StdlibPathError {
        error: &'a str,
    },
    ExtraPathMissing {
        path: &'a Utf8Path,
        warn: bool,
    },
    DirectoryAtDepthZero {
        path: &'a Utf8Path,
    },
    RecursionDepthExceeded {
        step: ArchiveStep,
        path: &'a Utf8Path,
        limit: usize,
        warn: bool,
    },
    UnknownFileType {
        step: ArchiveStep,
        path: &'a Utf8Path,
    },
    LinkedPathNotFound {
        path: &'a Utf8Path,
        requested_by: &'a [String],
    },
    Archived {
        file_count: usize,
        output_file: &'a Utf8Path,
        elapsed: Duration,
    },
    ExtractStarted {
        test_binary_count: usize,
        non_test_binary_count: usize,
        build_script_out_dir_count: usize,
        linked_path_count: usize,
        dest_dir: &'a Utf8Path,
    },
    Extracted {
        file_count: usize,
        dest_dir: &'a Utf8Path,
        elapsed: Duration,
    },
}

An archive event.

Events are produced by archive and extract operations, and consumed by an ArchiveReporter.

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.

ArchiveStarted

The archive process started.

Fields

counts: ArchiveCounts

File counts.

output_file: &'a Utf8Path

The archive output file.

StdlibPathError

An error occurred while obtaining the path to a standard library.

Fields

error: &'a str

The error that occurred.

ExtraPathMissing

A provided extra path did not exist.

Fields

path: &'a Utf8Path

The path that was missing.

warn: bool

Whether the reporter should produce a warning about this.

DirectoryAtDepthZero

For an extra include, a directory was specified at depth 0.

Fields

path: &'a Utf8Path

The directory that was at depth 0.

RecursionDepthExceeded

While performing the archive, the recursion depth was exceeded.

Fields

step: ArchiveStep

The current step in the archive process.

path: &'a Utf8Path

The path that exceeded the recursion depth.

limit: usize

The recursion depth limit that was hit.

warn: bool

Whether the reporter should produce a warning about this.

UnknownFileType

The archive process encountered an unknown file type.

Fields

step: ArchiveStep

The current step in the archive process.

path: &'a Utf8Path

The path of the unknown type.

LinkedPathNotFound

A crate linked against a non-existent path.

Fields

path: &'a Utf8Path

The path of the linked file.

requested_by: &'a [String]

The crates that linked against the path.

Archived

The archive operation completed successfully.

Fields

file_count: usize

The number of files archived.

output_file: &'a Utf8Path

The archive output file.

elapsed: Duration

How long it took to create the archive.

ExtractStarted

The extraction process started.

Fields

test_binary_count: usize

The number of test binaries to extract.

non_test_binary_count: usize

The number of non-test binaries to extract.

build_script_out_dir_count: usize

The number of build script output directories to archive.

linked_path_count: usize

The number of linked paths to extract.

dest_dir: &'a Utf8Path

The destination directory.

Extracted

The extraction process completed successfully.

Fields

file_count: usize

The number of files extracted.

dest_dir: &'a Utf8Path

The destination directory.

elapsed: Duration

How long it took to extract the archive.

Trait Implementations

impl<'a> Clone for ArchiveEvent<'a>

fn clone(&self) -> ArchiveEvent<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ArchiveEvent<'a>

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

Formats the value using the given formatter.