Struct Args 

pub struct Args {

    pub command: Commands,
    pub host: String,
    pub ip_from: IpFrom,
    pub rscript: OsString,
    pub quarto: OsString,
    pub log_file: Option<PathBuf>,
    pub max_log_file_size: Option<u64>,
    pub shutdown: Shutdown,
    pub max_message_size: Option<u64>,
    pub pg_con_string: Option<String>,
    pub pg_sslcert: Option<PathBuf>,
    pub pg_sslmode: PgSslMode,
    pub telemetry_namespace: String,
    pub telemetry_version: Option<String>,
}

███████╗ █████╗ ██╗ ██╗ ██████╗███████╗████████╗ ██╔════╝██╔══██╗██║ ██║██╔════╝██╔════╝╚══██╔══╝ █████╗ ███████║██║ ██║██║ █████╗ ██║ ██╔══╝ ██╔══██║██║ ██║██║ ██╔══╝ ██║ ██║ ██║ ██║╚██████╔╝╚██████╗███████╗ ██║ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═════╝╚══════╝ ╚═╝ Fast, async, and concurrent data applications.

Fields

command: Commands

host: String

The host to bind to.

ip_from: IpFrom

The IP address to extract from. Defaults to client address.

rscript: OsString

Command, path, or executable to run Rscript.

quarto: OsString

Command, path, or executable to run quarto.

log_file: Option<PathBuf>

Save logs to a file. Will disable colors!

max_log_file_size: Option<u64>

The maximum size of the log file. (Ex. 10M, 1GB)

shutdown: Shutdown

The strategy for shutting down faucet

max_message_size: Option<u64>

Maximum size of a WebSocket message. This is useful for DDOS prevention. Not set means no size limit.

pg_con_string: Option<String>

Connection string to a PostgreSQL database for saving HTTP events.

pg_sslcert: Option<PathBuf>

Path to CA certificate for PostgreSQL SSL/TLS.

pg_sslmode: PgSslMode

SSL mode for PostgreSQL connection (disable, prefer, require, verify-ca, verify-full).

telemetry_namespace: String

Save HTTP events on PostgreSQL under a specific namespace.

telemetry_version: Option<String>

Represents the source code version of the service to run. This is useful for telemetry.

Trait Implementations

impl Args for Args

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 Args

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 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.