Struct RenderOptions 

pub struct RenderOptions {
    pub base: String,
    pub default_view_name: String,
    pub interactive: bool,
    pub block_index: usize,
}

Rendering configuration supplied by the host (docgen).

Fields

base: String

Site base path (e.g. /docs or empty) prefixed onto internal note URLs.

default_view_name: String

Fallback title used for a view with no name.

interactive: bool

When true, emit the interactive DOM hooks + JSON payload the client-side island hydrates against. When false, output is byte-for-byte the pure static HTML (no data-* hooks, no payload script).

block_index: usize

Which base on the page this is: 0 for a standalone .base, else the index of the ```base block. Views number from 0 within their own base, so the emitted data-base-view is {block_index}-{view_index} — the island keys URL-hash segments and facet-panel DOM ids off that string, and two blocks on one page would otherwise both claim 0 and clobber each other.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderOptions

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

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.