Struct cargo_scaffold::Opts

pub struct Opts {
    pub template_path: PathBuf,
    pub repository_template_path: Option<PathBuf>,
    pub git_ref: Option<String>,
    pub project_name: Option<String>,
    pub target_dir: Option<PathBuf>,
    pub force: bool,
    pub append: bool,
    pub passphrase_needed: bool,
    pub private_key_path: Option<PathBuf>,
    pub parameters: Vec<String>,
}

Fields

template_path: PathBuf

Specifiy your template location

repository_template_path: Option<PathBuf>

Specifiy your template location in the repository if it’s not located at the root of your repository

git_ref: Option<String>

Full commit hash or tag from which the template is cloned (i.e.: “deed14dcbf17ba87f6659ea05755cf94cb1464ab” or “v0.5.0”)

project_name: Option<String>

Specify the name of your generated project (and so skip the prompt asking for it)

target_dir: Option<PathBuf>

Specifiy the target directory

force: bool

Override target directory if it exists

append: bool

Append files in the target directory, create directory with the project name if it doesn’t already exist but doesn’t overwrite existing file (use force for that kind of usage)

passphrase_needed: bool

Specify if your SSH key is protected by a passphrase

private_key_path: Option<PathBuf>

Specify if your private SSH key is located in another location than $HOME/.ssh/id_rsa

parameters: Vec<String>

Supply parameters via the command line in = format

Implementations

impl Opts

pub fn new(
    template_path: PathBuf,
    repository_template_path: Option<PathBuf>,
    git_ref: Option<String>,
    project_name: Option<String>,
    target_dir: Option<PathBuf>,
    force: Option<bool>,
    append: Option<bool>,
    passphrase_needed: Option<bool>,
    private_key_path: Option<PathBuf>,
    parameters: Vec<String>
) -> Opts

impl Opts

pub fn builder() -> NewOptsBuilder

Trait Implementations

impl StructOpt for Opts

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.