Struct git_trim::args::Args

pub struct Args {
    pub bases: Vec<String>,
    pub protected: Vec<String>,
    pub no_update: bool,
    pub update: bool,
    pub update_interval: Option<u64>,
    pub no_confirm: bool,
    pub confirm: bool,
    pub no_detach: bool,
    pub detach: bool,
    pub delete: Vec<DeleteRange>,
    pub dry_run: bool,
}

Fields

bases: Vec<String>

Comma separated multiple names of branches. All the other branches are compared with the upstream branches of those branches. [default: branches that tracks git symbolic-ref refs/remotes/*/HEAD] [config: trim.bases]

The default value is a branch that tracks git symbolic-ref refs/remotes/*/HEAD. They might not be reflected correctly when the HEAD branch of your remote repository is changed. You can see the changed HEAD branch name with git remote show <remote> and apply it to your local repository with git remote set-head <remote> --auto.

protected: Vec<String>

Comma separated multiple glob patterns (e.g. release-*, feature/*) of branches that should never be deleted. [config: trim.protected]

no_update: bool

Do not update remotes [config: trim.update]

update: bool

update_interval: Option<u64>

Prevents too frequent updates. Seconds between updates in seconds. 0 to disable. [default: 5] [config: trim.updateInterval]

no_confirm: bool

Do not ask confirm [config: trim.confirm]

confirm: bool

no_detach: bool

Do not detach when HEAD is about to be deleted [config: trim.detach]

detach: bool

delete: Vec<DeleteRange>

Comma separated values of <delete range>[:<remote name>]. Delete range is one of the merged, merged-local, merged-remote, stray, diverged, local, remote. :<remote name> is only necessary to a <delete range> when the range is applied to remote branches. You can use * as <remote name> to delete a range of branches from all remotes. [default : merged:origin] [config: trim.delete]

merged implies merged-local,merged-remote.

merged-local will delete merged tracking local branches. merged-remote:<remote> will delete merged upstream branches from <remote>. stray will delete tracking local branches, which is not merged, but the upstream is gone. diverged:<remote> will delete merged tracking local branches, and their upstreams from <remote> even if the upstreams are not merged and diverged from local ones. local will delete non-tracking merged local branches. remote:<remote> will delete non-upstream merged remote tracking branches. Use with caution when you are using other than merged. It might lose changes, and even nuke repositories.

dry_run: bool

Do not delete branches, show what branches will be deleted.

Implementations

impl Args

pub fn update(&self) -> Option<bool>

pub fn confirm(&self) -> Option<bool>

pub fn detach(&self) -> Option<bool>

Trait Implementations

impl Clap for Args

fn parse() -> Self

Parse from std::env::args(), exit on error

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

Parse from std::env::args(), 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.

impl Default for Args

fn default() -> Args

Returns the "default value" for a type.

impl FromArgMatches for Args

fn from_arg_matches(matches: &ArgMatches) -> Self

@TODO @release @docs

impl IntoApp for Args

fn into_app<'b>() -> App<'b>

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs

impl ParseArgs for Args

type Error = Error

Error type.

fn parse_args() -> Result<Self, Self::Error>

Try to parse an input to a type.