Struct Opt

pub struct Opt {
    pub upgrade: bool,
    pub daemon: bool,
    pub nocapture: bool,
    pub test: bool,
    pub conf: Option<String>,
}

Command-line options

Call Opt::parse_args() to build this object from the process’s command line arguments.

Fields

upgrade: bool

Whether this server should try to upgrade from a running old server

daemon: bool

Whether this server should run in the background

nocapture: bool

Not actually used. This flag is there so that the server is not upset seeing this flag passed from cargo test sometimes

test: bool

Test the configuration and exit

When this flag is set, calling server.bootstrap() will exit the process without errors

This flag is useful for upgrading service where the user wants to make sure the new service can start before shutting down the old server process.

conf: Option<String>

The path to the configuration file.

See ServerConf for more details of the configuration file.

Implementations

impl Opt

Create an instance of Opt by parsing the current command-line args. This is equivalent to running Opt::parse but does not require the caller to have included the clap::Parser

pub fn parse_args() -> Opt

Trait Implementations

impl Args for Opt

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl CommandFactory for Opt

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

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> App<'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 Opt

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

Formats the value using the given formatter.

impl Default for Opt

fn default() -> Opt

Returns the “default value” for a type.

impl FromArgMatches for Opt

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Opt, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Opt, 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 Opt

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.