Struct Companion 

pub struct Companion {
    pub output_name: String,
    pub bytes: Vec<u8>,
    pub media_type: String,
    pub title: String,
    pub source_dir: String,
    pub stem: String,
}

Companion document embedded in the switchback.

Fields

output_name: String

Output filename relative to the companion output directory.

bytes: Vec<u8>

Raw companion file bytes.

media_type: String

MIME type for the companion (e.g. "text/markdown").

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 Companion

fn clone(&self) -> Companion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Companion

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

Formats the value using the given formatter.

impl Eq for Companion

impl PartialEq for Companion

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