Struct TemplatePath

pub struct TemplatePath {
    pub auto_path: Option<String>,
    pub subfolder: Option<String>,
    pub test: bool,
    pub git: Option<String>,
    pub branch: Option<String>,
    pub tag: Option<String>,
    pub revision: Option<String>,
    pub path: Option<String>,
    pub favorite: Option<String>,
}

Fields

auto_path: Option<String>

Auto attempt to use as either --git or --favorite. If either is specified explicitly, use as subfolder.

subfolder: Option<String>

Specifies the subfolder within the template repository to be used as the actual template.

test: bool

Expand $CWD as a template, then run cargo test on the expansion (set $CARGO_GENERATE_TEST_CMD to override test command).

Any arguments given after the --test argument, will be used as arguments for the test command.

git: Option<String>

Git repository to clone template from. Can be a URL (like https://github.com/rust-cli/cli-template), a path (relative or absolute), or an owner/repo abbreviated GitHub URL (like rust-cli/cli-template).

Note that cargo generate will first attempt to interpret the owner/repo form as a relative path and only try a GitHub URL if the local path doesn’t exist.

branch: Option<String>

Branch to use when installing from git

tag: Option<String>

Tag to use when installing from git

revision: Option<String>

Git revision to use when installing from git (e.g. a commit hash)

path: Option<String>

Local path to copy the template from. Can not be specified together with –git.

favorite: Option<String>

Generate a favorite template as defined in the config. In case the favorite is undefined, use in place of the --git option, otherwise specifies the subfolder

Implementations

impl TemplatePath

pub fn any_path(&self) -> &str

Panics

Will panic if no path to a template has been set at all, which is never if Clap is initialized properly.

pub const fn git(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn branch(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn tag(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn revision(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn path(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn favorite(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn auto_path(&self) -> Option<&(impl AsRef<str> + '_)>

pub const fn subfolder(&self) -> Option<&(impl AsRef<str> + '_)>

Trait Implementations

impl Args for TemplatePath

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 Clone for TemplatePath

fn clone(&self) -> TemplatePath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TemplatePath

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

Formats the value using the given formatter.

impl Default for TemplatePath

fn default() -> TemplatePath

Returns the “default value” for a type.

impl FromArgMatches for TemplatePath

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.