Struct RunArgs 

pub struct RunArgs {
    pub config: Option<PathBuf>,
    pub from_env: bool,
    pub env_file: Option<PathBuf>,
    pub no_env_file: bool,
    pub dry_run: bool,
    pub limit: Option<usize>,
    pub state_path: Option<PathBuf>,
    pub clock: Option<String>,
}

faucet run arguments.

Fields

config: Option<PathBuf>

Path to a .yaml, .yml, or .json pipeline config. If omitted (and --from-env is not set), auto-discover faucet.yaml / faucet.yml / faucet.json in the current directory. Mutually exclusive with --from-env.

from_env: bool

Build the pipeline entirely from FAUCET_* environment variables — no YAML required. See cli/README.md for the variable schema.

env_file: Option<PathBuf>

Path to a .env file to load before reading variables. Works in both YAML mode (for ${env:VAR} interpolation) and --from-env mode. When omitted, .env in the current directory is auto-loaded if present. Existing process-env values always win over file-supplied ones.

no_env_file: bool

Skip auto-loading .env from the current directory.

dry_run: bool

Stop after fetching from the source — write nothing to the sink.

limit: Option<usize>

Stop after writing this many records to the sink. Default: unlimited.

state_path: Option<PathBuf>

Override the state-store directory (file backend only).

clock: Option<String>

Override the ${now.*} interpolation clock (RFC3339 like 2026-01-31T00:00:00Z, or a date 2026-01-31). Default: process start (UTC). Use for backfills.

Trait Implementations

impl Args for RunArgs

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 RunArgs

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 RunArgs

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

Formats the value using the given formatter.

impl FromArgMatches for RunArgs

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 RunArgs

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.