Struct CompileOnceArgs

pub struct CompileOnceArgs {
    pub input: Option<String>,
    pub root: Option<PathBuf>,
    pub font: CompileFontArgs,
    pub package: CompilePackageArgs,
    pub pdf: PdfExportArgs,
    pub png: PngExportArgs,
    pub features: Vec<Feature>,
    pub inputs: Vec<(String, String)>,
    pub creation_timestamp: Option<i64>,
    pub cert: Option<PathBuf>,
}

Common arguments to create a world (environment) to run typst tasks, e.g. compile, watch, and query.

Fields

input: Option<String>

Specify the path to input Typst file. If the path is relative, it will be resolved relative to the current working directory (PWD).

root: Option<PathBuf>

Configure the project root (for absolute paths).

font: CompileFontArgs

Specify the font related arguments.

package: CompilePackageArgs

Specify the package related arguments.

pdf: PdfExportArgs

Specify the PDF export related arguments.

png: PngExportArgs

Specify the PNG export related arguments.

features: Vec<Feature>

Enable in-development features that may be changed or removed at any time.

inputs: Vec<(String, String)>

Add a string key-value pair visible through sys.inputs.

Examples

Tell the script that sys.inputs.foo is "bar" (type: str).

tinymist compile --input foo=bar

creation_timestamp: Option<i64>

Configure the document’s creation date formatted as a UNIX timestamp (in seconds).

For more information, see https://reproducible-builds.org/specs/source-date-epoch/.

cert: Option<PathBuf>

Specify the path to CA certificate file for network access, especially for downloading typst packages.

Implementations

impl CompileOnceArgs

pub fn resolve_features(&self) -> Features

Resolves the features.

pub fn resolve_inputs(&self) -> Option<Arc<LazyHash<Dict>>>

Resolves the inputs.

pub fn resolve_sys_entry_opts(&self) -> Result<EntryOpts, Error>

Resolves the entry options.

impl CompileOnceArgs

pub fn resolve_system( &self, ) -> Result<CompilerUniverse<SystemCompilerFeat>, Error>

Resolves the arguments into a system universe. This is also a sample implementation of how to resolve the arguments (user inputs) into a universe.

Trait Implementations

impl Args for CompileOnceArgs

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 CompileOnceArgs

fn clone(&self) -> CompileOnceArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CompileOnceArgs

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 CompileOnceArgs

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

Formats the value using the given formatter.

impl Default for CompileOnceArgs

fn default() -> CompileOnceArgs

Returns the “default value” for a type.

impl FromArgMatches for CompileOnceArgs

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

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<CompileOnceArgs, 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 CompileOnceArgs

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.

impl WorldProvider for CompileOnceArgs

fn resolve(&self) -> Result<LspUniverse>

Get a universe instance from the given arguments.

fn entry(&self) -> Result<EntryOpts>

Get the entry options from the arguments.