Struct ExplanationSidecar 

pub struct ExplanationSidecar {
    pub file: String,
    pub summary: String,
    pub explanation: String,
    pub tags: Vec<String>,
    pub related_artifacts: Vec<String>,
}

Schema for .diff.explanation.yaml sidecar files.

Example YAML:

file: src/auth/middleware.rs
summary: "Refactored auth middleware to use JWT instead of session tokens"
explanation: |
  Replaced session-based auth with JWT validation. The middleware now
  checks the Authorization header for a Bearer token, validates it
  against the JWKS endpoint, and extracts claims into the request context.
  This change touches 3 files: middleware.rs (core logic), config.rs
  (JWT settings), and tests/auth_test.rs (updated test fixtures).
tags: [security, breaking-change]
related_artifacts:
  - src/auth/config.rs
  - tests/auth_test.rs

Fields

file: String

The file this explanation applies to (relative path from workspace root).

summary: String

One-line summary.

explanation: String

Multi-line explanation of what changed and why.

tags: Vec<String>

Optional tags for categorization.

related_artifacts: Vec<String>

Related artifacts (paths relative to workspace root).

Implementations

impl ExplanationSidecar

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ChangeSetError>

Parse an explanation sidecar from a YAML file.

pub fn into_tiers(self) -> ExplanationTiers

Convert this sidecar into ExplanationTiers (for embedding in Artifact).

Normalizes related_artifacts to URI format (fs://workspace/).

pub fn find_for_file<P: AsRef<Path>>(file_path: P) -> Option<Self>

Find explanation sidecar for a given file path.

Looks for: <file_path>.diff.explanation.yaml

Returns None if the sidecar doesn’t exist (this is not an error — sidecars are optional).

Trait Implementations

impl Clone for ExplanationSidecar

fn clone(&self) -> ExplanationSidecar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplanationSidecar

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExplanationSidecar

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ExplanationSidecar

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExplanationSidecar

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ExplanationSidecar

impl StructuralPartialEq for ExplanationSidecar