Enum RegisterSubcommand

pub enum RegisterSubcommand {
    CrateFiles {
        crate_name: PathBuf,
        skip_git_check: bool,
    },
    AllFiles {
        workspace_path: PathBuf,
        skip_git_check: bool,
    },
    Internal {
        prefix_crate: PathBuf,
        new_crate: PathBuf,
        workspace_path: Option<PathBuf>,
        skip_git_check: bool,
    },
}

Register subcommand for naming files, adding crate references, etc.

Variants

CrateFiles

Ensure all source files in a single crate are “registered” (that is, it calls CrateHandle::ensure_all_source_files_are_registered()).

Fields

crate_name: PathBuf

Path (or name) of the crate directory

skip_git_check: bool

If true, skip checking for Git cleanliness

AllFiles

Ensure all source files in every crate of a workspace are “registered.” (Calls Workspace::ensure_all_source_files_are_registered().)

Fields

workspace_path: PathBuf

Path to the workspace root

skip_git_check: bool

If true, skip checking for Git cleanliness

Internal

Register a new internal crate in a “prefix group” crate by adding a [dependencies] entry in the prefix crate’s Cargo.toml plus a pub use new_crate_name::*; line in src/lib.rs.

Fields

prefix_crate: PathBuf

Path (or name) of the prefix crate

new_crate: PathBuf

Path (or name) of the new crate to add

workspace_path: Option<PathBuf>

Optionally specify the workspace root path (defaults to current directory if omitted).

skip_git_check: bool

If true, skip checking for Git cleanliness

Implementations

impl RegisterSubcommand

pub async fn run(&self) -> Result<(), WorkspaceError>

Trait Implementations

impl Debug for RegisterSubcommand

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

Formats the value using the given formatter.

impl StructOpt for RegisterSubcommand

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

where Self: Sized,

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>

where Self: Sized,

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 Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + 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 Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

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