Struct typst_preview::CliArguments

pub struct CliArguments {
    pub preview: PreviewArgs,
    pub preview_mode: PreviewMode,
    pub static_file_host: String,
    pub dont_open_in_browser: bool,
    pub inputs: Vec<(String, String)>,
    pub ignore_system_fonts: bool,
    pub font_paths: Vec<PathBuf>,
    pub root: Option<PathBuf>,
    pub input: PathBuf,
}

Fields

preview: PreviewArgs

preview_mode: PreviewMode

Preview mode

static_file_host: String

Host for the preview server

dont_open_in_browser: bool

Don’t open the preview in the browser after compilation.

inputs: Vec<(String, String)>

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

ignore_system_fonts: bool

Ensures system fonts won’t be searched, unless explicitly included via --font-path

font_paths: Vec<PathBuf>

Add additional directories to search for fonts

root: Option<PathBuf>

Root directory for your project

input: PathBuf

Trait Implementations

impl Args for CliArguments

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 CliArguments

fn clone(&self) -> CliArguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CliArguments

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 CliArguments

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

Formats the value using the given formatter.

impl FromArgMatches for CliArguments

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 CliArguments

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.