Struct BackendOptions

pub struct BackendOptions<E: Extension> {
    pub backend: Backend<E>,
    pub dry_run: bool,
    pub verbose: u8,
    pub stats: bool,
    pub profile: bool,
    pub debug_engine: Option<DebugEngineMode>,
    pub extract_type_aliases: bool,
    pub translation_options: TranslationOptions,
    pub output_dir: Option<PathBuf>,
    pub cli_extension: E::BackendOptions,
}

Fields

backend: Backend<E>

dry_run: bool

Don’t write anything on disk. Output everything as JSON to stdout instead.

verbose: u8

Verbose mode for the Hax engine. Set -vv for maximal verbosity.

stats: bool

Prints statistics about how many items have been translated successfully by the engine.

profile: bool

Enables profiling for the engine: for each phase of the engine, time and memory usage are recorded and reported.

debug_engine: Option<DebugEngineMode>

Enable engine debugging: dumps the AST at each phase.

The value of <DEBUG_ENGINE> can be either: {n}{n} - interactive (or i): enables debugging of the engine, and visualize interactively in a webapp how a crate was transformed by each phase, both in Rust-like syntax and browsing directly the internal AST. By default, the webapp is hosted on http://localhost:8000, the port can be override by setting the HAX_DEBUGGER_PORT environment variable. {n} - <FILE> or file:<FILE>: outputs the different AST as JSON to <FILE>. <FILE> can be either [-] or a path.

extract_type_aliases: bool

Extract type aliases. This is disabled by default, since extracted terms depends on expanded types rather than on type aliases. Turning this option on is discouraged: Rust type synonyms can ommit generic bounds, which are ususally necessary in the hax backends, leading to typechecking errors. For more details see https://github.com/hacspec/hax/issues/708.

translation_options: TranslationOptions

output_dir: Option<PathBuf>

Where to put the output files resulting from the translation. Defaults to “/proofs//extraction”.

cli_extension: E::BackendOptions

Trait Implementations

impl<E: Extension> Args for BackendOptions<E>

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl<E: Clone + Extension> Clone for BackendOptions<E>

where E::BackendOptions: Clone,

fn clone(&self) -> BackendOptions<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Extension> CommandFactory for BackendOptions<E>

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<E: Debug + Extension> Debug for BackendOptions<E>

where E::BackendOptions: Debug,

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

Formats the value using the given formatter.

impl<'de, E> Deserialize<'de> for BackendOptions<E>

where E: Deserialize<'de> + Extension, E::BackendOptions: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: Extension> FromArgMatches for BackendOptions<E>

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<E: Extension + JsonSchema> JsonSchema for BackendOptions<E>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<E: Extension> Parser for BackendOptions<E>

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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<E> Serialize for BackendOptions<E>

where E: Serialize + Extension, E::BackendOptions: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.