Struct ReportGenerator 

#[non_exhaustive]
pub struct ReportGenerator {
    pub version: String,
    pub commit: Option<String>,
    pub dirty: Option<bool>,
}

The dataprof build that produced a report.

version alone cannot tell a development build from the release it follows: both carry the workspace version until the next release bumps it. The commit and the dirty flag tell them apart where the build knows them.

Absent commit and dirty mean the build did not record them: a crate built from a package rather than a git checkout, or a build without a usable git. An explicit null is malformed, so neither the reader nor the schema accepts one.

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.

version: String

The dataprof package version, such as "0.13.0".

commit: Option<String>

The full git commit hash the build was compiled from.

dirty: Option<bool>

Whether the compiled sources (Cargo.toml, Cargo.lock and crates/) had uncommitted changes when the build ran.

Implementations

impl ReportGenerator

pub fn current() -> Self

The build running now.

Trait Implementations

impl Clone for ReportGenerator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReportGenerator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReportGenerator

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReportGenerator

impl JsonSchema for ReportGenerator

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ReportGenerator

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReportGenerator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReportGenerator