Struct TaskCompileArgs

pub struct TaskCompileArgs {
    pub declare: DocNewArgs,
    pub when: Option<TaskWhen>,
    pub output: Option<String>,
    pub format: Option<OutputFormat>,
    pub pages: Option<Vec<Pages>>,
    pub pdf: PdfExportArgs,
    pub png: PngExportArgs,
    pub output_format: OnceLock<Result<OutputFormat>>,
}

Declare an compile task.

Fields

declare: DocNewArgs

Specify the argument to identify a project.

when: Option<TaskWhen>

Configure when to run the task.

output: Option<String>

Provide the path to output file (PDF, PNG, SVG, or HTML). Use - to write output to stdout.

For output formats emitting one file per page (PNG & SVG), a page number template must be present if the source document renders to multiple pages. Use {p} for page numbers, {0p} for zero padded page numbers and {t} for page count. For example, page-{0p}-of-{t}.png creates page-01-of-10.png, page-02-of-10.png, and so on.

format: Option<OutputFormat>

Specify the format of the output file, inferred from the extension by default.

pages: Option<Vec<Pages>>

Specify which pages to export. When unspecified, all pages are exported.

Pages to export are separated by commas, and can be either simple page numbers (e.g. ‘2,5’ to export only pages 2 and 5) or page ranges (e.g. ‘2,3-6,8-’ to export page 2, pages 3 to 6 (inclusive), page 8 and any pages after it).

Page numbers are one-indexed and correspond to physical page numbers in the document (therefore not being affected by the document’s page counter).

pdf: PdfExportArgs

Specify the PDF export related arguments.

png: PngExportArgs

Specify the PNG export related arguments.

output_format: OnceLock<Result<OutputFormat>>

Specify the output format.

Implementations

impl TaskCompileArgs

pub fn to_task(self, doc_id: Id, cwd: &Path) -> Result<ApplyProjectTask>

Converts the arguments to a project task.

Trait Implementations

impl Args for TaskCompileArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::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 Clone for TaskCompileArgs

fn clone(&self) -> TaskCompileArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for TaskCompileArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for TaskCompileArgs

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

Formats the value using the given formatter.

impl FromArgMatches for TaskCompileArgs

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.

impl Parser for TaskCompileArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.