Struct charon_lib::options::CliOpts

pub struct CliOpts {

    pub ullbc: bool,
    pub lib: bool,
    pub bin: Option<String>,
    pub mir_promoted: bool,
    pub mir_optimized: bool,
    pub crate_name: Option<String>,
    pub input_file: Option<PathBuf>,
    pub dest_dir: Option<PathBuf>,
    pub dest_file: Option<PathBuf>,
    pub use_polonius: bool,
    pub no_code_duplication: bool,
    pub extract_opaque_bodies: bool,
    pub include: Vec<String>,
    pub opaque: Vec<String>,
    pub exclude: Vec<String>,
    pub hide_marker_traits: bool,
    pub no_cargo: bool,
    pub rustc_args: Vec<String>,
    pub cargo_args: Vec<String>,
    pub abort_on_error: bool,
    pub error_on_warnings: bool,
    pub no_serialize: bool,
    pub print_original_ullbc: bool,
    pub print_ullbc: bool,
    pub print_built_llbc: bool,
    pub print_llbc: bool,
    pub no_merge_goto_chains: bool,
}

Fields

ullbc: bool

Extract the unstructured LLBC (i.e., don’t reconstruct the control-flow)

lib: bool

Compile the package’s library

bin: Option<String>

Compile the specified binary

mir_promoted: bool

Extract the promoted MIR instead of the built MIR

mir_optimized: bool

Extract the optimized MIR instead of the built MIR

crate_name: Option<String>

Provide a custom name for the compiled crate (ignore the name computed by Cargo)

input_file: Option<PathBuf>

The input file (the entry point of the crate to extract). This is needed if you want to define a custom entry point (to only extract part of a crate for instance).

dest_dir: Option<PathBuf>

The destination directory. Files will be generated as <dest_dir>/<crate_name>.{u}llbc, unless dest_file is set. dest_dir defaults to the current directory.

dest_file: Option<PathBuf>

The destination file. By default <dest_dir>/<crate_name>.llbc. If this is set we ignore dest_dir.

use_polonius: bool

If activated, use Polonius’ non-lexical lifetimes (NLL) analysis. Otherwise, use the standard borrow checker.

no_code_duplication: bool

extract_opaque_bodies: bool

Usually we skip the bodies of foreign methods and structs with private fields. When this flag is on, we don’t.

include: Vec<String>

Whitelist of items to translate. These use the name-matcher syntax.

opaque: Vec<String>

Blacklist of items to keep opaque. These use the name-matcher syntax.

exclude: Vec<String>

Blacklist of items to not translate at all. These use the name-matcher syntax.

hide_marker_traits: bool

Whether to hide the Sized, Sync, Send and Unpin marker traits anywhere they show up.

no_cargo: bool

Do not run cargo; instead, run the driver directly.

rustc_args: Vec<String>

Extra flags to pass to rustc.

cargo_args: Vec<String>

Extra flags to pass to cargo. Incompatible with --no-cargo.

abort_on_error: bool

Panic on the first error. This is useful for debugging.

error_on_warnings: bool

Print the errors as warnings

no_serialize: bool

print_original_ullbc: bool

print_ullbc: bool

print_built_llbc: bool

print_llbc: bool

no_merge_goto_chains: bool

Implementations

impl CliOpts

pub fn validate(&self)

Check that the options are meaningful

Trait Implementations

impl Args for CliOpts

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 Clone for CliOpts

fn clone(&self) -> CliOpts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for CliOpts

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 CliOpts

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

Formats the value using the given formatter.

impl Default for CliOpts

fn default() -> CliOpts

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CliOpts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for CliOpts

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 CliOpts

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 Serialize for CliOpts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.