Struct Sketch

pub struct Sketch {
    pub name: String,
    pub compilation_success: bool,
    pub sizes: Vec<SketchSizeKind>,
    pub warnings: Option<SketchWarnings>,
}

A data structure used to describe a compiled sketch.

Fields

name: String

The relative path to the sketch compiled.

Often relative to the project’s root directory.

compilation_success: bool

Was sketch successfully compiled?

sizes: Vec<SketchSizeKind>

The compile size of the sketch.

This Vec typically includes details about SketchSizeKind::Flash and SketchSizeKind::Ram.

warnings: Option<SketchWarnings>

The number of compilation warnings (if any).

This information is only included in the report artifacts when the enable-warnings-report option is enabled for arduino/compile-sketches.

Trait Implementations

impl Debug for Sketch

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

Formats the value using the given formatter.

impl Default for Sketch

fn default() -> Sketch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Sketch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.