Struct FormatDocumentRequest 

pub struct FormatDocumentRequest {
    pub style: StyleInput,
    pub style_overrides: Option<String>,
    pub locale: Option<String>,
    pub output_format: OutputFormatKind,
    pub refs: RefsInput,
    pub citations: Vec<CitationOccurrence>,
    pub bibliography_blocks: Vec<BibliographyBlockRequest>,
    pub document_options: Option<DocumentOptions>,
}

A request to format a complete document’s citations and bibliography.

Fields

style: StyleInput

The style to use (may be resolved locally or by an adapter).

style_overrides: Option<String>

Optional partial-style overlay (YAML or JSON) merged over the resolved base style for this request only.

Accepts any subset of the style YAML schema — e.g. just options.contributors to change and/et-al behaviour, or a full citation spec. Uses the same null-aware, typed-merge semantics as extends inheritance: supplied fields win over base style fields; an explicit ~ (null) value clears an inherited field. The base style is never mutated.

locale: Option<String>

Optional locale override as a BCP 47 language tag (e.g. en-US). When omitted or set to en-US the engine uses its built-in en-US locale; other locales emit a warning and fall back to en-US until adapter-side locale resolution is wired through.

output_format: OutputFormatKind

Output format (plain, html, djot, latex, typst). Defaults to plain when omitted from the request.

refs: RefsInput

Reference input as a local path, inline YAML, inline JSON, or legacy bare map.

citations: Vec<CitationOccurrence>

Ordered citations as they appear in the document.

bibliography_blocks: Vec<BibliographyBlockRequest>

Ordered sectional bibliography blocks to render after citations.

document_options: Option<DocumentOptions>

Optional document-level configuration.

Trait Implementations

impl Clone for FormatDocumentRequest

fn clone(&self) -> FormatDocumentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FormatDocumentRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FormatDocumentRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FormatDocumentRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.