Struct TemplateRegisterArgs 

pub struct TemplateRegisterArgs {
    pub config: PathBuf,
    pub id: Option<String>,
    pub description: Option<String>,
    pub tag: Vec<String>,
    pub launch: bool,
    pub common: TemplateStoreArgs,
}

Available on crate feature templates only.

faucet template register <config> arguments.

Fields

config: PathBuf

Path to the .yaml, .yml, or .json config to register. Stored verbatim, so ${env:…} / ${vault:…} stay unresolved and are resolved when a run is triggered.

id: Option<String>

Registry id. Derived from the config’s name: when omitted.

description: Option<String>

Free-text description shown by list / show.

tag: Vec<String>

Point a named channel at the newly registered version, e.g. --tag dev --tag test. The version number itself always auto-increments; channels come from a fixed set (dev, test, staging, pre-prod, canary, stable, prod, previous). latest is derived and always names the newest version, so it cannot be assigned.

launch: bool

Launch the new version immediately, making it the one unpinned runs use. Without this the version is registered but inert — a new build never moves existing callers until you launch it.

common: TemplateStoreArgs

Trait Implementations

impl Args for TemplateRegisterArgs

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 TemplateRegisterArgs

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 TemplateRegisterArgs

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

Formats the value using the given formatter.

impl FromArgMatches for TemplateRegisterArgs

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 TemplateRegisterArgs

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.