Struct Args

pub struct Args {
    pub filename: PathBuf,
    pub depth: usize,
    pub language: &'static str,
    pub game_path: Option<PathBuf>,
    pub include: Vec<PathBuf>,
    pub output: PathBuf,
    pub dump: Option<PathBuf>,
    pub dump_data: Option<PathBuf>,
    pub no_vis: bool,
    pub no_interaction: bool,
    pub use_internal: bool,
}

The arguments to the program.

Fields

filename: PathBuf

The path to the save file.

depth: usize

The depth to render the player’s history. The higher the number, the larger quantity of data will be rendered.

language: &'static str

The language to use for localization.

game_path: Option<PathBuf>

The path to the game files. Be sure to point to the /game subdirectory.

include: Vec<PathBuf>

The paths that contain assets that should be considered during rendering. Mainly mods and the such.

output: PathBuf

The output path for the rendered files. Within this directory, the program will create subdirectories for each player.

dump: Option<PathBuf>

A flag that tells the program to dump the game state to a json file.

dump_data: Option<PathBuf>

A path to a file to dump the game data to.

no_vis: bool

A flag that tells the program not to render any images.

no_interaction: bool

A flag that tells the program not to interact with the user.

use_internal: bool

A flag that tells the program to use the internal templates instead of the templates in the templates folder.

Implementations

impl Args

pub fn get_from_user() -> Self

Create the object based on user input.

Trait Implementations

impl Args for Args

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 CommandFactory for Args

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 FromArgMatches for Args

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 Args

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.