Struct magoo::InstallCommand

pub struct InstallCommand {
    pub url: Option<String>,
    pub path: Option<String>,
    pub branch: Option<String>,
    pub name: Option<String>,
    pub depth: Option<usize>,
    pub force: bool,
    pub options: PrintOptions,
}

The install command

Fields

url: Option<String>

URL of the git repository to add

See the add command of https://git-scm.com/docs/git-submodule for what formats are supported.

path: Option<String>

Local path to clone the git submodule to

Unlike the path specified with git submodule add, this path should be relative from the top level (root) of the git repository.

branch: Option<String>

Branch to checkout and track

This is the branch reference that will be used when updating the submodule. If not specified, the behavior is the same as git submodule add without --branch (HEAD is used)

name: Option<String>

Name of the submodule

If not specified, the name of the submodule is the same as the path.

depth: Option<usize>

Depth to clone the submodule

force: bool

Whether to force the submodule to be added

This will pass the --force flag to git submodule add and git submodule update.

options: PrintOptions

Print options

Implementations

impl InstallCommand

pub fn set_print_options(&self)

Apply the print options

pub fn run(&self, dir: &str) -> Result<(), GitError>

Run the command in the given directory

Trait Implementations

impl Args for InstallCommand

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for InstallCommand

fn clone(&self) -> InstallCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for InstallCommand

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 InstallCommand

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

Formats the value using the given formatter.

impl FromArgMatches for InstallCommand

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 InstallCommand

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) -> Selfwhere 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.

impl PartialEq for InstallCommand

fn eq(&self, other: &InstallCommand) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InstallCommand