Struct FieldDocumentation 

pub struct FieldDocumentation {
    pub name: String,
    pub text: String,
    pub command: Option<String>,
    pub present: bool,
}

Single entry inside FieldExplanation::fields.

Names one YAML field path (e.g. commits[].analysis.diff_file), explains it, optionally links a git command that produces the underlying data, and carries a runtime present flag set by RepositoryView::update_field_presence before serialization. See ADR-0013.

Fields

name: String

Name of the field being documented.

text: String

Descriptive text explaining what the field contains.

command: Option<String>

Git command that corresponds to this field (if applicable).

present: bool

Whether this field is present in the current output.

Trait Implementations

impl Clone for FieldDocumentation

fn clone(&self) -> FieldDocumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDocumentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FieldDocumentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FieldDocumentation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.