Struct inoculate::Options

pub struct Options {
    pub cmd: Option<Subcommand>,
    pub kernel_bin: PathBuf,
    pub kernel_manifest: Option<PathBuf>,
    pub out_dir: Option<PathBuf>,
    pub target_dir: Option<PathBuf>,
    pub cargo_path: PathBuf,
    pub output: OutputOptions,
    pub bootloader: BootloaderOptions,
}

Fields

cmd: Option<Subcommand>

Which command to run?

By default, an image is built but not run.

kernel_bin: PathBuf

The path to the kernel binary.

kernel_manifest: Option<PathBuf>

The path to the kernel’s Cargo manifest. If this is not provided, it will be located automatically.

out_dir: Option<PathBuf>

Overrides the directory in which to build the output image.

target_dir: Option<PathBuf>

Overrides the target directory for the kernel build.

cargo_path: PathBuf

Overrides the path to the cargo executable.

By default, this is read from the CARGO environment variable.

output: OutputOptions

bootloader: BootloaderOptions

Configures the bootloader.

Implementations

impl Options

pub fn cargo_cmd(&self, cmd: &str) -> Command

impl Options

pub fn is_test(&self) -> bool

pub fn wheres_the_kernel(&self) -> Result<PathBuf>

pub fn wheres_the_kernel_bin(&self) -> Result<PathBuf>

pub fn paths(&self) -> Result<Paths>

pub fn make_image(&self, paths: &Paths) -> Result<PathBuf>

Trait Implementations

impl Args for Options

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 CommandFactory for Options

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 Options

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

Formats the value using the given formatter.

impl FromArgMatches for Options

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 Options

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.