Struct Cli 

pub struct Cli {
    pub command: Commands,
    pub log_level: Option<String>,
    pub log_file: Option<PathBuf>,
    pub metrics_port: Option<u16>,
    pub no_metrics: bool,
    pub keyring_path: Option<PathBuf>,
}

Pigeon: authenticate, sink, and transform personal data from external services.

Fields

command: Commands

log_level: Option<String>

Tracing filter directive for the durable JSONL log (e.g. “info” or “pigeon=debug”). Defaults to $RUST_LOG, or “warn,pigeon=info” if that isn’t set either (ADR-0073).

log_file: Option<PathBuf>

Overrides where the durable JSONL log is written. Defaults to $PIGEON_LOG_DIR/pigeon.jsonl, or the OS-conventional local-data directory for pigeon if that isn’t set either (ADR-0073).

metrics_port: Option<u16>

Port for the local Prometheus metrics endpoint an on-host observability agent (e.g. Grafana Alloy) can scrape (ADR-0092). Defaults to $PIGEON_METRICS_PORT, or 9091 if that isn’t set either.

no_metrics: bool

Disables the local Prometheus metrics endpoint entirely (ADR-0092).

keyring_path: Option<PathBuf>

Overrides the keyring file’s location. Defaults to $PIGEON_CONFIG_DIR/keyring.toml, or the OS-conventional config directory for pigeon if that isn’t set either (ADR-0145).

Trait Implementations

impl Args for Cli

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 Cli

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 Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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 Cli

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.