Struct ConfigReport 

pub struct ConfigReport {
    pub file: String,
    pub exists: bool,
    pub committed: bool,
    pub valid: bool,
    pub error: Option<String>,
    pub sections: Vec<ConfigSection>,
    pub diff: Option<String>,
}

Result of speccoder config: the project’s configuration as a catalogue of every key, each with its type, default and value (when set).

Fields

file: String

The file, relative to the project root.

exists: bool

Whether it exists.

committed: bool

Whether it is committed as it is on disk (speccoder reads committed configuration only, so an uncommitted change is not yet in force).

valid: bool

Whether every parser accepts it.

error: Option<String>

The first parser’s complaint, when not valid.

sections: Vec<ConfigSection>

Sections, in the reference’s order.

diff: Option<String>

The uncommitted change, as a diff, when there is one.

Trait Implementations

impl Clone for ConfigReport

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 ConfigReport

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

Formats the value using the given formatter.

impl JsonSchema for ConfigReport

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 ConfigReport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ConfigReport

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 ConfigReport