Struct RenderArgs 

pub struct RenderArgs {

    pub path: PathBuf,
    pub scene: Option<PathBuf>,
    pub png: Option<PathBuf>,
    pub pdf: Option<PathBuf>,
    pub embed_full_fonts: bool,
    pub page: Option<usize>,
    pub all_pages: Option<PathBuf>,
    pub spread: Option<String>,
    pub gutter: Option<u32>,
    pub locked: bool,
    pub json: bool,
    pub allow: Vec<String>,
    pub warn: Vec<String>,
    pub deny: Vec<String>,
    pub data: Option<PathBuf>,
}

Arguments for zenith render.

Fields

path: PathBuf

Path to the .zen document.

scene: Option<PathBuf>

Write the compiled scene display-list JSON to this path.

png: Option<PathBuf>

Write the rendered PNG to this path.

pdf: Option<PathBuf>

Write a vector PDF (with print boxes + DeviceCMYK) to this path.

embed_full_fonts: bool

Embed whole font programs in the PDF instead of subsetting to used glyphs.

PDF text is always selectable and searchable; this only trades a larger file for embedding the complete face (default: subset for small files).

page: Option<usize>

1-based page number to render; for --pdf, the default renders all pages.

Without --page, single-output flags (--scene/--png) render page 1, while --pdf renders every page into one multi-page PDF. Passing --page N selects exactly that page for all outputs.

all_pages: Option<PathBuf>

Render every page to <DIR>/page-<N>.png (1-based) instead of a single page.

spread: Option<String>

Render two facing pages side by side as a single PNG, e.g. --spread 10-11 (1-based page numbers; A on the left, B on the right). Requires --png.

gutter: Option<u32>

Override the spread gutter in pixels (default: the document’s spread-gutter, or 0). Only used when --spread is set.

locked: bool

Verify each image asset’s bytes against its declared sha256 and fail on mismatch.

json: bool

Emit machine-readable JSON (diagnostics + output path) to stdout.

allow: Vec<String>

Suppress a diagnostic code (downgrade Warning/Advisory to nothing).

Repeatable. Overrides the document’s in-file diagnostics block and any global/local config policy for this code.

warn: Vec<String>

Force a diagnostic code to Warning severity.

Repeatable. Overrides the document’s in-file diagnostics block and any global/local config policy for this code.

deny: Vec<String>

Elevate a diagnostic code to a blocking Error (CI gate).

Repeatable. Overrides the document’s in-file diagnostics block and any global/local config policy for this code.

data: Option<PathBuf>

Path to a JSON object/array or CSV file supplying values for (data)"field.path" references. JSON nested keys flatten to dot-paths ({"a":{"b":1}} → "a.b"); a JSON array uses the first element. CSV header row gives field names; the first data row supplies values. Produces a SINGLE render bound to the first object/row; for BATCH output (one PNG per CSV row with a provenance manifest) use zenith merge instead.

Trait Implementations

impl Args for RenderArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Debug for RenderArgs

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

Formats the value using the given formatter.

impl FromArgMatches for RenderArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.