Struct ListenerAddressLFlag

pub struct ListenerAddressLFlag {
    pub listen_address: Option<ListenerAddress>,
    pub listener_options: UserOptions,
}

Clap helper to provide optional listener address a named argument --listen-address or -l.

For clap(flatten)-ing into your primary options struct.

Also invides a number of additional optional options to adjust the way it listens.

Provides documentation about how to specify listening addresses into --help.

Example:

#[derive(Parser)]
/// Doc comment here is highly adviced
struct Args {
   #[clap(flatten)]
   listener: tokio_listener::ListenerAddressLFlag,
}

Fields

listen_address: Option<ListenerAddress>

Socket address to listen for incoming connections.

Various types of addresses are supported:

• TCP socket address and port, like 127.0.0.1:8080 or [::]:80

• UNIX socket path like /tmp/mysock or Linux abstract address like @abstract

• Special keyword “inetd” for serving one connection from stdin/stdout

• Special keyword “sd-listen” to accept connections from file descriptor 3 (e.g. systemd socket activation). You can also specify a named descriptor after a colon or * to use all passed sockets (if this feature is enabled)

listener_options: UserOptions

Implementations

impl ListenerAddressLFlag

pub async fn bind(&self) -> Option<Result<Listener>>

Simple function to activate the listener (if it is set) without any extra parameters (just as nodelay, retries or keepalives) based on supplied arguments.

Trait Implementations

impl Args for ListenerAddressLFlag

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 ListenerAddressLFlag

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 ListenerAddressLFlag

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 ListenerAddressLFlag

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.