Skip to main content

Renderer

Trait Renderer 

Source
pub trait Renderer: Send + Sync {
    type Opts: Send + Sync;

    // Required method
    async fn render(
        &self,
        manual: &ReferenceManual,
        opts: &Self::Opts,
    ) -> Result<Vec<OutputFile>>;
}
Expand description

Async renderer for service-side and streaming pipelines.

Primary API per ADR 0002. Renderer crates implement this trait against a family-specific Options type.

Required Associated Types§

Source

type Opts: Send + Sync

Renderer-specific options (layout, paths, escaping, etc.).

Required Methods§

Source

async fn render( &self, manual: &ReferenceManual, opts: &Self::Opts, ) -> Result<Vec<OutputFile>>

Renders a ReferenceManual into one or more output files.

Dyn Compatibility§

This trait is not dyn compatible.

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

Implementors§