Struct CompanionFile 

pub struct CompanionFile {
    pub output_name: String,
    pub bytes: Vec<u8>,
    pub source_path: PathBuf,
    pub title: String,
    pub source_dir: String,
    pub stem: String,
}

Parser-side companion file discovered beside contract inputs.

Used during parse and companion discovery; converted to wire Companion via companion_files_to_stored. The source_path field is parser-local and not serialized on the wire.

Fields

output_name: String

Output filename for the companion in the rendered book.

bytes: Vec<u8>

Raw companion file bytes.

source_path: PathBuf

Filesystem path where the companion was discovered.

Parser-local provenance only; not serialized on the wire.

title: String

Human nav label (first markdown heading or humanized stem).

source_dir: String

Logical source directory relative to corpus root (slash-separated).

stem: String

Source filename stem (e.g. README, MOVING-TO-V2).

Trait Implementations

impl Clone for CompanionFile

fn clone(&self) -> CompanionFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompanionFile

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

Formats the value using the given formatter.

impl Eq for CompanionFile

impl PartialEq for CompanionFile

fn eq(&self, other: &CompanionFile) -> 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 StructuralPartialEq for CompanionFile