Struct OutputTemplate 

pub struct OutputTemplate { /* private fields */ }

A parsed -o / --output template.

Implementations

impl OutputTemplate

pub fn parse(raw: &str) -> Result<Self, TemplateError>

Parse a user-supplied -o value.

Recognises %d and %0Nd as the page-number conversion and %% as an escaped literal %. Every other % sequence is an error, so a typo like %s is reported rather than silently written to disk.

pub fn has_page_token(&self) -> bool

Whether this template carries a %d page-number conversion.

pub fn raw(&self) -> &str

The template as the user wrote it.

pub fn expand( &self, page_number: i32, emitted_index: u32, ) -> Result<String, ExpandError>

Expand the template for a 1-based page number.

emitted_index is the 1-based count of pages actually written so far including this one — not the logical page number, which --pages 3 would make 3 for a job that emits a single file. A template without a %d is only valid while that count is 1.

Trait Implementations

impl Clone for OutputTemplate

fn clone(&self) -> OutputTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputTemplate

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

Formats the value using the given formatter.

impl Eq for OutputTemplate

impl PartialEq for OutputTemplate

fn eq(&self, other: &OutputTemplate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OutputTemplate