Struct tvix_eval::Evaluation
source · pub struct Evaluation<'co, 'ro, 'env, IO> {
pub(crate) source_map: SourceCode,
pub(crate) globals: Rc<GlobalsMap>,
pub(crate) env: Option<&'env FxHashMap<SmolStr, Value>>,
pub(crate) io_handle: IO,
pub(crate) strict: bool,
pub(crate) nix_path: Option<String>,
pub(crate) compiler_observer: Option<&'co mut dyn CompilerObserver>,
pub(crate) runtime_observer: Option<&'ro mut dyn RuntimeObserver>,
}
Expand description
An Evaluation
represents how a piece of Nix code is evaluated. It can be
instantiated and configured directly, or it can be accessed through the
various simplified helper methods available below.
Public fields are intended to be set by the caller. Setting all fields is optional.
Fields§
§source_map: SourceCode
Source code map used for error reporting.
globals: Rc<GlobalsMap>
Set of all global values available at the top-level scope
env: Option<&'env FxHashMap<SmolStr, Value>>
Top-level variables to define in the evaluation
io_handle: IO
Implementation of file-IO to use during evaluation, e.g. for impure builtins.
Defaults to DummyIO
if not set explicitly.
strict: bool
Determines whether the returned value should be strictly evaluated, that is whether its list and attribute set elements should be forced recursively.
nix_path: Option<String>
(optional) Nix search path, e.g. the value of NIX_PATH
used
for resolving items on the search path (such as <nixpkgs>
).
compiler_observer: Option<&'co mut dyn CompilerObserver>
(optional) compiler observer for reporting on compilation details, like the emitted bytecode.
runtime_observer: Option<&'ro mut dyn RuntimeObserver>
(optional) runtime observer, for reporting on execution steps of Nix code.
Implementations§
source§impl<'co, 'ro, 'env, IO> Evaluation<'co, 'ro, 'env, IO>
impl<'co, 'ro, 'env, IO> Evaluation<'co, 'ro, 'env, IO>
sourcepub fn builder(io_handle: IO) -> EvaluationBuilder<'co, 'ro, 'env, IO>
pub fn builder(io_handle: IO) -> EvaluationBuilder<'co, 'ro, 'env, IO>
Make a new builder for configuring an evaluation
sourcepub fn globals(&self) -> Rc<GlobalsMap>
pub fn globals(&self) -> Rc<GlobalsMap>
Clone the reference to the map of Nix globals for this evaluation. If Value
s are shared
across subsequent Evaluation
s, it is important that those evaluations all have the same
underlying globals map.
sourcepub fn source_map(&self) -> SourceCode
pub fn source_map(&self) -> SourceCode
Clone the reference to the contained source code map. This is used after an evaluation for
pretty error printing. Also, if Value
s are shared across subsequent Evaluation
s, it
is important that those evaluations all have the same underlying source code map.
source§impl<'co, 'ro, 'env> Evaluation<'co, 'ro, 'env, Box<dyn EvalIO>>
impl<'co, 'ro, 'env> Evaluation<'co, 'ro, 'env, Box<dyn EvalIO>>
pub fn builder_impure() -> EvaluationBuilder<'co, 'ro, 'env, Box<dyn EvalIO>>
pub fn builder_pure() -> EvaluationBuilder<'co, 'ro, 'env, Box<dyn EvalIO>>
source§impl<'co, 'ro, 'env, IO> Evaluation<'co, 'ro, 'env, IO>
impl<'co, 'ro, 'env, IO> Evaluation<'co, 'ro, 'env, IO>
sourcepub fn compile_only(
self,
code: impl AsRef<str>,
location: Option<PathBuf>,
) -> EvaluationResult
pub fn compile_only( self, code: impl AsRef<str>, location: Option<PathBuf>, ) -> EvaluationResult
Only compile the provided source code, at an optional location of the source code (i.e. path to the file it was read from; used for error reporting, and for resolving relative paths in impure functions) This does not run the code, it only provides analysis (errors and warnings) of the compiler.