Enum CtlSubcommand

pub(crate) enum CtlSubcommand {
    Download(Box<DownloadSubcommand>),
    Generate(Box<GenerateSubcommand>),
    Unpack(Box<UnpackSubcommand>),
    Upgrade(Box<UpgradeSubcommand>),
    Wizard(Box<WizardSubcommand>),
    Packages(Box<PackageSubcommand>),
    Data(Box<DataSubcommand>),
    Policies(Box<PolicySubcommand>),
    Start {
        docker_socket: PathBuf,
        docker_version: ClientVersion,
        exe: String,
        file: Option<PathBuf>,
        version: Version,
        image_dir: PathBuf,
        local_aux: bool,
        skip_import: bool,
        profile_dir: Option<PathBuf>,
        kind: Box<StartSubcommand>,
    },
    Stop {
        exe: String,
        file: Option<PathBuf>,
    },
    Logs {
        exe: String,
        file: Option<PathBuf>,
    },
    Version {
        arch: bool,
        kind: bool,
        ctl: bool,
        node: bool,
    },
}

Defines subcommands for the branectl tool.

Variants

Download(Box<DownloadSubcommand>)

Generate(Box<GenerateSubcommand>)

Unpack(Box<UnpackSubcommand>)

Upgrade(Box<UpgradeSubcommand>)

Wizard(Box<WizardSubcommand>)

Packages(Box<PackageSubcommand>)

Data(Box<DataSubcommand>)

Policies(Box<PolicySubcommand>)

Start

Fields

docker_socket: PathBuf

docker_version: ClientVersion

exe: String

The docker-compose command we run.

file: Option<PathBuf>

The docker-compose file that we start.

version: Version

The specific Brane version to start.

image_dir: PathBuf

Sets the ‘$IMG_DIR’ variable, which can easily switch the location of compiled binaries.

local_aux: bool

If given, will use locally downloaded versions of the auxillary images.

skip_import: bool

Whether to skip importing images or not.

profile_dir: Option<PathBuf>

The profile directory to mount, if any.

kind: Box<StartSubcommand>

Defines the possible nodes and associated flags to start.

Stop

Fields

exe: String

The docker-compose command we run.

file: Option<PathBuf>

The docker-compose file that we start.

Logs

Fields

exe: String

The docker-compose command we run.

file: Option<PathBuf>

The docker-compose file that we start.

Version

Fields

arch: bool

kind: bool

ctl: bool

node: bool

Trait Implementations

impl Debug for CtlSubcommand

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

Formats the value using the given formatter.

impl FromArgMatches for CtlSubcommand

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 CtlSubcommand

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