Enum Commands 

pub enum Commands {
    Add {
        source: PathBuf,
        target: Option<PathBuf>,
        contents: bool,
        name: Option<String>,
    },
    List,
    Info {
        id: String,
    },
    Remove {
        id: String,
        with_target: bool,
    },
    Config {
        action: ConfigAction,
    },
    Update {
        id: String,
        source: Option<PathBuf>,
        target: Option<PathBuf>,
        name: Option<String>,
    },
    Migrate {
        id: String,
        dest: Option<PathBuf>,
    },
    Metadata {
        action: MetadataAction,
    },
}

The Commands enum defines the various commands that the bonds CLI application supports. Each variant corresponds to a specific action that can be performed on the bonds, such as adding a new bond, listing existing bonds, updating bond information, and managing metadata. Some commands have their own subcommands for more granular actions, such as the Config and Metadata commands. This structure allows for a clear and organized command-line interface, making it easier for users to understand and use the available functionality of the CLI application.

Variants

Add

Create a new bond from source to target

Fields

source: PathBuf

The source directory or file to bond

target: Option<PathBuf>

The target location (defaults to current directory + source name)

contents: bool

Bond each child of source as a separate bond into target

name: Option<String>

Give this bond a name for easy reference

List

List all bonds

Info

Show details of a specific bond

Fields

id: String

Bond ID

Remove

Remove a bond

Fields

id: String

Bond ID

with_target: bool

Also delete the target directory/file (not just the symlink)

Config

View or modify configuration

Fields

action: ConfigAction

Update

Update an existing bond’s source or target

Fields

id: String

Bond ID (or prefix)

source: Option<PathBuf>

New source path

target: Option<PathBuf>

New target path

name: Option<String>

Set or change the bond’s name

Migrate

Move a bond’s target to a new directory

Fields

id: String

Bond name or ID prefix

dest: Option<PathBuf>

Destination directory (defaults to configured default directory)

Metadata

Read or modify metadata for a bond

Fields

action: MetadataAction

Trait Implementations

impl FromArgMatches for Commands

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Commands

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand