Struct mitex_cli::CompileArgs

pub struct CompileArgs {
    pub workspace: String,
    pub input: String,
    pub stage: Option<CompileStage>,
    pub output: String,
    /* private fields */
}

Compile arguments.

Fields

workspace: String

Path to workspace.

This is used to resolve imports in \iftypst blocks.

Example

mitex compile -w '/my-workspace' main.tex

Resolves /some-file.typ with /my-workspace/some-file.typ

\iftypst
#import "/some-file.typ"
\fi

input: String

Entry file.

Example

mitex compile main.tex

Example

mitex compile -i main.tex

stage: Option<CompileStage>

Compile stage.

Example

mitex compile --stage syntax main.tex

Example

mitex compile --stage document main.tex

output: String

Output to file, default to entry file name with .typ extension.

Example

mitex compile main.tex main.typ

Example

mitex compile -i main.tex -o main.typ

Example

mitex compile --stage syntax main.tex main.ast.txt

Trait Implementations

impl Args for CompileArgs

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.

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

Append to Command so it can update self.

impl Clone for CompileArgs

fn clone(&self) -> CompileArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CompileArgs

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 CompileArgs

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

Formats the value using the given formatter.

impl Default for CompileArgs

fn default() -> CompileArgs

Returns the “default value” for a type.

impl FromArgMatches for CompileArgs

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 CompileArgs

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.