Struct tvix_cli::args::Args

pub struct Args {

    pub script: Option<PathBuf>,
    pub expr: Option<String>,
    pub display_ast: bool,
    pub dump_bytecode: bool,
    pub trace_runtime: bool,
    pub trace_runtime_timing: bool,
    pub compile_only: bool,
    pub no_warnings: bool,
    pub nix_search_path: Option<String>,
    pub raw: bool,
    pub strict: bool,
    pub service_addrs: ServiceUrlsMemory,
    pub build_service_addr: String,
    pub drv_dumpdir: Option<PathBuf>,
}

Provides a CLI interface to trigger evaluation using tvix-eval.

Uses configured tvix-[ca]store and tvix-build components, and by default a set of builtins similar to these present in Nix.

None of the stores available add to the local /nix/store location.

The CLI interface is not stable and subject to change.

Fields

script: Option<PathBuf>

Path to a script to evaluate

expr: Option<String>

display_ast: bool

Dump the raw AST to stdout before interpreting

dump_bytecode: bool

Dump the bytecode to stdout before evaluating

trace_runtime: bool

Trace the runtime of the VM

trace_runtime_timing: bool

Capture the time (relative to the start time of evaluation) of all events traced with --trace-runtime

compile_only: bool

Only compile, but do not execute code. This will make Tvix act sort of like a linter.

no_warnings: bool

Don’t print warnings.

nix_search_path: Option<String>

A colon-separated list of directories to use to resolve <...>-style paths

raw: bool

Print “raw” (unquoted) output.

strict: bool

Strictly evaluate values, traversing them and forcing e.g. elements of lists and attribute sets before printing the return value.

service_addrs: ServiceUrlsMemory

build_service_addr: String

drv_dumpdir: Option<PathBuf>

An optional path in which Derivations encountered during evaluation are dumped into, after evaluation. If it doesn’t exist, the directory is created.

Files dumped there are named like they would show up in /nix/store, if produced by Nix. Existing files are not overwritten.

This is only for debugging and diffing purposes for post-eval inspection; Tvix does not read from these.

Trait Implementations

impl Args for Args

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

fn clone(&self) -> Args

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Args

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 FromArgMatches for Args

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 Args

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.