Trait CompanionStrategy 

pub trait CompanionStrategy: Send + Sync {
    // Required methods
    fn discovery(&self) -> CompanionDiscovery;
    fn output_name(&self, source_dir: &[&str], stem: &str) -> String;
    fn companion_media_types(&self) -> &'static [&'static str];

    // Provided methods
    fn companion_title(&self, stem: &str, bytes: &[u8]) -> String { ... }
    fn discover_local(&self, contract_root: &Path) -> Result<Vec<CompanionFile>> { ... }
}

How a family discovers, names, and places companion docs (sync, local).

Associated with ContractFamily via ContractFamily::CompanionStrategy.

Required Methods

fn discovery(&self) -> CompanionDiscovery

Returns the filesystem search strategy for companion files.

fn output_name(&self, source_dir: &[&str], stem: &str) -> String

Computes the output filename for a companion given its source directory path segments and stem.

fn companion_media_types(&self) -> &'static [&'static str]

MIME types accepted for companion documents in this family.

Provided Methods

fn companion_title(&self, stem: &str, bytes: &[u8]) -> String

Human nav title for a companion (default: first markdown # heading).

fn discover_local(&self, contract_root: &Path) -> Result<Vec<CompanionFile>>

Discovers companions on the local filesystem relative to contract inputs.

Default returns empty; families with companion docs override.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors