Struct Shipped 

#[non_exhaustive]
pub struct Shipped {
    pub tree: PathBuf,
    pub archive: Option<PathBuf>,
    pub prefix: String,
    pub debug: Option<PathBuf>,
    pub sources: BTreeMap<String, (FileKind, String)>,
    pub inputs: Vec<(String, String, PathBuf)>,
    pub public: Vec<PathBuf>,
    pub varying: BTreeMap<String, String>,
}

What an export wrote and where, as its exporter says: the rest of a package’s files are the inspector’s to find.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tree: PathBuf

The package’s folder.

archive: Option<PathBuf>

The archive made of it, if any.

prefix: String

What starts the name of each file in the archive.

debug: Option<PathBuf>

The debug file beside it, if any.

sources: BTreeMap<String, (FileKind, String)>

Each file the exporter knows of, by its path in the package, with its kind and source.

inputs: Vec<(String, String, PathBuf)>

What shipped files were made from, as FileKind::BuildInput: each one’s name, what it is, and the file.

public: Vec<PathBuf>

Other folders this export published the same bytes in, emptied with the package.

varying: BTreeMap<String, String>

The files a tool writes differently each build, by path, with what starts the line it changes: their hashes leave that line out, and the archive’s hash is of its files, so the same input gives the same report.

Implementations

impl Shipped

pub fn new( tree: PathBuf, archive: Option<PathBuf>, prefix: impl Into<String>, ) -> Self

The package in tree, with archive made of it under prefix.

pub fn source( &mut self, path: impl Into<String>, kind: FileKind, source: impl Into<String>, )

Says what the file at path in the package is and where it is from.

Trait Implementations

impl Clone for Shipped

fn clone(&self) -> Shipped

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shipped

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

Formats the value using the given formatter.

impl Eq for Shipped

impl PartialEq for Shipped

fn eq(&self, other: &Shipped) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Shipped