Struct cargo_ghp_upload::Args
[−]
[src]
struct Args { deploy_branch: String, publish_branch: Vec<String>, publish_tags: bool, token: Option<String>, message: String, upload_directory: PathBuf, clobber_index: bool, verbosity: u8, }
Upload documentation straight to GitHub Pages while maintaining branch separation and history
Fields
deploy_branch: String
The branch used for GitHub Pages
publish_branch: Vec<String>
Branches to publish
Publish documentation for tag builds (GitHub releases)
token: Option<String>
GitHub Personal Access token
message: String
Message for the git commit
upload_directory: PathBuf
The directory to publish the files from
clobber_index: bool
verbosity: u8
Methods
impl Args
[src]
pub fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>
[src]
Trait Implementations
impl Debug for Args
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl StructOpt for Args
[src]
fn clap<'a, 'b>() -> App<'a, 'b>
[src]
Returns the corresponding clap::App
.
fn from_clap(matches: &ArgMatches) -> Self
[src]
Creates the struct from clap::ArgMatches
. It cannot fail with a parameter generated by clap
by construction. Read more
fn from_args() -> Self
Gets the struct from the command line arguments. Print the error message and quit the program in case of failure. Read more
fn from_iter<I>(iter: I) -> Self where
I: IntoIterator,
<I as IntoIterator>::Item: Into<OsString>,
<I as IntoIterator>::Item: Clone,
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. Read more