Struct structopt_flags::HostOpt

pub struct HostOpt { /* private fields */ }

This struct provides the --host and -H cli option to get ageneric IP address

No default is provided

extern crate structopt_flags;
#[macro_use]
extern crate structopt;

use std::net::{IpAddr,Ipv6Addr};
use structopt::StructOpt;
use structopt_flags::GetWithDefault; // to access get_with_default

#[derive(Debug, StructOpt)]
#[structopt(name = "ip_opt", about = "An example using the HostOpt option")]
struct Opt {
    #[structopt(flatten)]
    host_ip: structopt_flags::HostOpt,
}

fn main() {
    let opt = Opt::from_args();
    let ip = opt.host_ip.get_with_default(IpAddr::V6(Ipv6Addr::new(0,0,0,0,0,0,0,1)));
}

Trait Implementations

impl Clone for HostOpt

fn clone(&self) -> HostOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HostOpt

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

Formats the value using the given formatter.

impl GetWithDefault for HostOpt

type Item = IpAddr

fn get_with_default(&self, default: Self::Item) -> Self::Item

This function can be used to retrieve the value of the command line option taking in account the default value used as argument

impl StructOpt for HostOpt

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Selfwhere
    Self: Sized,

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Selfwhere
    Self: Sized,
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>where
    Self: Sized,
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.