Struct Outcome 

#[non_exhaustive]
pub struct Outcome {
    pub manifest_hash: u64,
    pub report: Report,
    pub locales: Vec<LocaleInfo>,
    pub source_locale: String,
    pub written: Vec<PathBuf>,
    pub removed: Vec<PathBuf>,
    pub generated: String,
    pub catalogs_module: String,
    pub out_dir: PathBuf,
    /* private fields */
}

What a build produced.

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.

manifest_hash: u64

Its hash — what the wasm and every catalog agree on.

report: Report

Everything the build has to say.

locales: Vec<LocaleInfo>

The locale table the generated module carries.

source_locale: String

The source locale.

written: Vec<PathBuf>

The files whose bytes changed (and were written).

removed: Vec<PathBuf>

Old catalogs removed.

generated: String

The generated Rust module’s source.

catalogs_module: String

The catalog table’s source, when the build emits it apart (Emit::Catalogs); empty otherwise.

out_dir: PathBuf

Where the outputs went.

Implementations

impl Outcome

pub fn is_clean(&self) -> bool

Whether the corpus had no errors.

pub fn into_result(self) -> Result<Outcome>

The outcome if the corpus was clean, else the error a build script fails with — the report is printed before it, as warnings and errors.

pub fn publish(&self, dir: &Path) -> Result<Published>

Writes what a static host serves into dir: every catalog under its content-hashed name (with its .br and .gz, when the build compressed them) and index.json, {"<tag>": "<file name>", …}, which a client-only application reads to find them. Nothing else — not the manifest, not the generated module — so the whole directory can be published as it is. Catalogs an earlier publish left in dir are removed; each file is written only when its bytes change.

The catalogs are immutable and may be cached forever; the index is not, and a host should serve it no-cache.

Trait Implementations

impl Debug for Outcome

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

Formats the value using the given formatter.