Struct Args

pub struct Args {

    pub input: Option<PathBuf>,
    pub output: Option<PathBuf>,
    pub config: Option<PathBuf>,
    pub method: Option<Method>,
    pub url_prefix: Option<String>,
    pub format: Option<Format>,
    pub combined: bool,
    pub metadata: Option<PathBuf>,
    pub watch: bool,
    pub watch_throttle: u64,
    pub verbose: u8,
    pub input_files: Vec<PathBuf>,
    pub metadata_version: MetadataVersion,
}

The definition of program arguments. Args has a higher priority than FileConfig. If no value is specified for a configuration item in either Args or FileConfig, the default value is used.

Fields

input: Option<PathBuf>

(deprecated) input file path. if not specified, use stdin.

output: Option<PathBuf>

output file prefix. if both of [INPUT_FILES] and --output are not specified, use stdout.

config: Option<PathBuf>

config file path. if --config option is specified and the configuration file fails to load, this program will exit with an error for security reasons.

method: Option<Method>

HTTP Method: "get" | "post"

url_prefix: Option<String>

Server’s URL Prefix. default: "http://www.plantuml.com/plantuml/". example: "http://localhost:8080/".

format: Option<Format>

output format: "svg" | "png" | "txt"

combined: bool

output pre-proccessed data has .puml extension

metadata: Option<PathBuf>

output path for metadata

watch: bool

watch over input files

watch_throttle: u64

watch throttle msec

verbose: u8

increase log level: -v -> info, -vv -> debug. if the PSCR_LOG environment variable is specified, this -v option will ignore. related: init_logger

input_files: Vec<PathBuf>

input file paths. if not specified, use stdin.

metadata_version: MetadataVersion

The version of metadata

Implementations

impl Args

pub async fn config(self) -> Result<Config>

Creates a Config from Args.

pub fn mode(&self, current_dir: PathBuf) -> Mode

Returns the mode of execution.

pub fn output_arc(&self) -> Arc<Locate>

Returns the locate of output.

Trait Implementations

impl Args for Args

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

fn clone(&self) -> Args

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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 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.