Struct Cli

pub struct Cli {
    pub command: String,
    pub source: PathBuf,
    pub source_type: Option<String>,
    pub target: Option<PathBuf>,
    pub target_type: Option<String>,
    pub filter: Option<String>,
    pub duplicates: bool,
    pub output: PathBuf,
    pub business: bool,
    pub alternate: Option<PathBuf>,
    pub alternate_type: Option<String>,
}

The Cli struct provides the command-line interface for the address library.

Fields

command: String

The command field specifies the command for the program to run. Currently accepts ‘compare’, ‘drift’, ‘filter’, ‘save’, ‘orphan_streets’ and ‘lexisnexis’ as values.

• filter
  • takes crate::MatchRecords as input
  • takes crate::BusinessMatchRecords with the -b flag

source: PathBuf

The source field specifies the path the source address file.

source_type: Option<String>

The source_type field contains a designator for the address source. Currently accepts ‘grants_pass’ and ‘josephine_county’ as values.

target: Option<PathBuf>

The target field specifies the path the target address file.

target_type: Option<String>

The target_type field contains a designator for the address target. Currently accepts ‘grants_pass’ and ‘josephine_county’ as values.

filter: Option<String>

The filter field contains a value to filter the target data. Currently accepts missing, divergent, matching, subaddress, floor, building and status as values.

duplicates: bool

The duplicates flag instructs the program to search for duplicate addresses.

output: PathBuf

The output field specifies the path for the output file.

business: bool

The business flag indicates the source addresses are from business licenses.

alternate: Option<PathBuf>

The alternate field specifies an alternate target path for addresses.

alternate_type: Option<String>

The alternate_type field contains a designator for the target addresses. Currently accepts ‘grants_pass’ and ‘josephine_county’.

Trait Implementations

impl Args for Cli

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

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 Cli

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 Cli

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.