Enum orca::opt::OrcaOpt

pub enum OrcaOpt {
    SetupWizard {
        common: CommonOpt,
        admin_password: String,
        idm_admin_password: String,
        control_uri: String,
        seed: Option<i64>,
        profile_path: PathBuf,
        threads: Option<usize>,
        model: Model,
        dump_raw_data: bool,
    },
    TestConnection {
        common: CommonOpt,
        profile_path: PathBuf,
    },
    GenerateData {
        common: CommonOpt,
        profile_path: PathBuf,
        state_path: PathBuf,
    },
    PopulateData {
        common: CommonOpt,
        state_path: PathBuf,
    },
    Run {
        common: CommonOpt,
        state_path: PathBuf,
    },
    Version {
        common: CommonOpt,
    },
}

Variants

SetupWizard

Fields

common: CommonOpt

admin_password: String

Update the admin password

idm_admin_password: String

Update the idm_admin password

control_uri: String

Update the Kanidm URI

seed: Option<i64>

Optional RNG seed. Takes a signed 64bit integer and turns it into an unsigned one for use. This allows deterministic regeneration of a test state file.

profile_path: PathBuf

The configuration file path to update (or create)

threads: Option<usize>

Optional thread count, defaults to maximum available on the system

model: Model

dump_raw_data: bool

Dump raw data to a separate csv file, defaults to false

TestConnection

Perform a connection test

Fields

common: CommonOpt

profile_path: PathBuf

Path to the test profile.

GenerateData

Create a new state file that is populated with a complete dataset, ready to be loaded into a kanidm instance.

Fields

common: CommonOpt

profile_path: PathBuf

Path to the test profile.

state_path: PathBuf

Path to the state file.

PopulateData

Populate the data for the test into the Kanidm instance.

Fields

common: CommonOpt

state_path: PathBuf

Path to the state file.

Run

Run the simulation.

Fields

common: CommonOpt

state_path: PathBuf

Path to the state file.

Version

Print version info and exit

Fields

common: CommonOpt

Implementations

impl OrcaOpt

pub(crate) fn debug(&self) -> bool

Trait Implementations

impl CommandFactory for OrcaOpt

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 OrcaOpt

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

Formats the value using the given formatter.

impl FromArgMatches for OrcaOpt

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 Parser for OrcaOpt

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::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][Error::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 Subcommand for OrcaOpt

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