Struct RenderOptions 

#[non_exhaustive]
pub struct RenderOptions {
    pub output_format: Option<OutputFormat>,
    pub ppi: Option<f32>,
    pub pages: Option<Vec<usize>>,
    pub producer: Option<String>,
    pub regions: bool,
}

Internal rendering options.

Built from Default and narrowed by the with_* setters:

use quillmark_core::{OutputFormat, RenderOptions};

let opts = RenderOptions::default()
    .with_output_format(OutputFormat::Png)
    .with_ppi(300.0);

#[non_exhaustive] forbids every out-of-crate struct expression, functional update included, so the setters are the construction path rather than a convenience beside one. Reading and assigning an individual field still works: opts.ppi = Some(300.0) is equivalent to the setter.

This is the render surface’s growth point: a new option is a new field here. Under the attribute that costs a caller nothing.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

output_format: Option<OutputFormat>

Optional output format specification

ppi: Option<f32>

Pixels per inch for raster output formats (e.g., PNG). Ignored for vector/document formats (PDF, SVG). Defaults to 144.0 (2x at 72pt/inch) when None.

pages: Option<Vec<usize>>

Optional 0-based page indices to render (e.g., vec![0, 2] for the first and third pages). None renders all pages. Any index >= page_count fails with a RenderError carrying the typst::page_index_out_of_bounds code: call LiveSession::page_count() first if validation is needed. Backends that do not support page selection (notably PDF) fail with a RenderError carrying typst::pdf_page_selection_not_supported when this is Some.

producer: Option<String>

Override for the PDF /Info /Producer metadata string. None uses the backend default (Quillmark <version> for the Typst backend). Applies to PDF output only; ignored by SVG/PNG.

regions: bool

Populate RenderResult::regions with the schema-field geometry sidecar (the same entries LiveSession::regions serves), for consumers without a live session, static overlays over exported SVG, PDF post-processing, CI coverage probes. Default false: exports pay no introspection cost, and the sidecar stays a request, not a promise.

The sidecar always describes the whole document (page indices are document-space and unaffected by a pages subset selection) so it never disagrees with the geometry of the compile it came from.

Implementations

impl RenderOptions

pub fn with_output_format(self, output_format: OutputFormat) -> RenderOptions

Set output_format.

pub fn with_ppi(self, ppi: f32) -> RenderOptions

Set ppi.

pub fn with_pages(self, pages: Vec<usize>) -> RenderOptions

Set pages.

pub fn with_producer(self, producer: String) -> RenderOptions

Set producer.

pub fn with_regions(self, regions: bool) -> RenderOptions

Request the geometry sidecar (regions).

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<(), Error>

Formats the value using the given formatter.

impl Default for RenderOptions

fn default() -> RenderOptions

Returns the “default value” for a type.