Struct StanhopeArgs

pub(crate) struct StanhopeArgs {
    pub(crate) listgen: String,
    pub(crate) webmenu: bool,
    pub(crate) process_ebml: String,
    pub(crate) scriptify_process: Vec<String>,
    pub(crate) archive_process: String,
    pub(crate) inspect_process: String,
    pub(crate) cleanup_previous: String,
    pub(crate) verbose: bool,
    pub(crate) ebml_help: bool,
}

Command Line Interface (CLI) argument structure

Fields

listgen: String

Read a single CSV file to create many new first-draft processes from scratch

• CSV-FILE
  • Comma-separated text file that strictly conforms to the template below
  • Exception: TFlag columns (7th column and beyond) are user-defined
  • Free Excel file to modify and export as CSV: https://stanhope.strativusgroup.com/latest/DocumentList.xlsx

“Document Number”	“Title”	“Subject”	“Product”	“Author”	“Reviewer”	TFlag	TFlag	…
…	…	…	…	…	…	x		…
…	…	…	…	…	…		x	…
…	…	…	…	…	…			…
…	…	…	…	…	…	x	x	…

webmenu: bool

Generate (or overwrite) a menu that indexes useful information for every process in a library WebMenu.html is generated in the Process Library root folder

process_ebml: String

Read a single EBML and produce an HTML file as well as a PDF of that process

• DOCUMENT-NUMBER should be surrounded by quotes, particularly if wildcards are used
  • Wildcards are accepted, e.g. *, ?, [0-9]
  • Wildcards follow “glob” formatting: https://docs.rs/glob/0.3.3/glob/struct.Pattern.html

scriptify_process: Vec<String>

Export every “Command” line from a single process into a script with a defined language/format

• DOCUMENT-NUMBER should be surrounded by quotes, particularly if wildcards are used
  • Wildcards are accepted, e.g. *, ?, [0-9]
  • Wildcards follow “glob” formatting: https://docs.rs/glob/0.3.3/glob/struct.Pattern.html
• SCRIPT-FORMAT can be “bash” or “powershell” or “python” or “applescript”
• PAUSE-AFTER-EACH
  • {“true”,“1”} to insert a format-specific wait after each command
  • {“false”,“0”} to script with no waiting

archive_process: String

Only perform the archiving process, i.e. create a new archive in “previous” Note: this operation is performed at the end of every “Process EBML” action This option only performs the archiving, not the processing.

• DOCUMENT-NUMBER should be surrounded by quotes, particularly if wildcards are used
  • Wildcards are accepted, e.g. *, ?, [0-9]
  • Wildcards follow “glob” formatting: https://docs.rs/glob/0.3.3/glob/struct.Pattern.html

inspect_process: String

Inspect a document by reading its EBML and returning information (no file generation)

• DOCUMENT-NUMBER should be surrounded by quotes, particularly if wildcards are used
  • Wildcards are accepted, e.g. *, ?, [0-9]
  • Wildcards follow “glob” formatting: https://docs.rs/glob/0.3.3/glob/struct.Pattern.html

cleanup_previous: String

Delete all but one “previous” version for each Revision for a given process For example, for a document that has many “previous” copies across four Revisions (-,A,B,C), then this option deletes all subdirectories except four: the one with the latest timestamp for each Revision variant

verbose: bool

Output more information to stdout as Stanhope executes (flag)

ebml_help: bool

Display syntax help for Easy Button Markup Language (EBML)

Trait Implementations

impl Args for StanhopeArgs

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 StanhopeArgs

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 StanhopeArgs

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

Formats the value using the given formatter.

impl FromArgMatches for StanhopeArgs

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 StanhopeArgs

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.