Enum StructuredOutput

#[non_exhaustive]
pub enum StructuredOutput {
    BuildFinished {
        path: PathBuf,
    },
    BuildUpdate {
        stage: BuildStage,
    },
    CargoOutput {
        message: CompilerMessage,
    },
    BundleOutput {
        bundles: Vec<PathBuf>,
    },
    HtmlTranslate {
        html: String,
    },
    Success,
    Error {
        message: String,
    },
}

The structured output for the CLI

This is designed such that third party tools can reliably consume the output of the CLI when outputting json.

Not every log outputted will be parsable, but all structured logs should be.

This means the debug format of this log needs to be parsable json, not the default debug format.

We guarantee that the last line of the command represents the success of the command, such that tools can simply parse the last line of the output.

There might be intermediate lines that are parseable as structured logs (which you can put here) but they are not guaranteed to be, such that we can provide better error messages for the user.

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.

BuildFinished

Fields

path: PathBuf

BuildUpdate

Fields

stage: BuildStage

CargoOutput

Fields

message: CompilerMessage

BundleOutput

Fields

bundles: Vec<PathBuf>

HtmlTranslate

Fields

html: String

Success

Error

Fields

message: String

Trait Implementations

impl Clone for StructuredOutput

fn clone(&self) -> StructuredOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StructuredOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.