Struct ipv4_heatmap::Args

pub(crate) struct Args {
    pub(crate) palette: String,
    pub(crate) invert: bool,
    pub(crate) reverse: bool,
    pub(crate) filename: String,
    pub(crate) output: String,
    pub(crate) annotations: Option<String>,
    pub(crate) legend_file: Option<String>,
    pub(crate) crop: Option<String>,
    pub(crate) mask: Option<String>,
}

Supported CLI args

Fields

palette: String

color palette to use; one of (blues br_bg bu_gn bu_pu cividis cool gn_bu greens greys inferno magma or_rd oranges pi_yg plasma pr_gn pu_bu pu_bu_gn pu_or pu_rd purples rainbow rd_bu rd_gy rd_pu rd_yl_bu rd_yl_gn reds sinebow spectral turbo viridis warm yl_gn yl_gn_bu yl_or_br yl_or_rd)

invert: bool

invert the chosen color palette

reverse: bool

reverse the heatmap base (i.e. white background, black text)

filename: String

input file of IPs

output: String

heatmap output file; extenstion determines format

annotations: Option<String>

file containing JSON CIDR annotations

legend_file: Option<String>

output an SVG colourbar legend to this file

crop: Option<String>

crop output to area represented by these CIDRs (comma separated CIDR list)

mask: Option<String>

Hilight only certain CIDRs in the heatmap image. Can be used with the “crop” argument to produce a masked and cropped heatmap image.

Trait Implementations

impl Args for Args

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to [Command] so it can update self.

impl CommandFactory for Args

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a [Command] that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

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.