Struct tvix_eval::Evaluation

source ·
pub struct Evaluation<'co, 'ro, IO> {
    pub(crate) source_map: SourceCode,
    pub builtins: Vec<(&'static str, Value)>,
    pub src_builtins: Vec<(&'static str, &'static str)>,
    pub io_handle: IO,
    pub enable_import: bool,
    pub strict: bool,
    pub nix_path: Option<String>,
    pub compiler_observer: Option<&'co mut dyn CompilerObserver>,
    pub 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.

§builtins: Vec<(&'static str, Value)>

Set of all builtins that should be available during the evaluation.

This defaults to all pure builtins. Users might want to add the set of impure builtins, or other custom builtins.

§src_builtins: Vec<(&'static str, &'static str)>

Set of builtins that are implemented in Nix itself and should be compiled and inserted in the builtins set.

§io_handle: IO

Implementation of file-IO to use during evaluation, e.g. for impure builtins.

Defaults to DummyIO if not set explicitly.

§enable_import: bool

Determines whether the import builtin should be made available. Note that this depends on the io_handle being able to read the files specified as arguments to import.

§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, IO> Evaluation<'co, 'ro, IO>
where IO: AsRef<dyn EvalIO> + 'static,

source

pub fn new(io_handle: IO, enable_import: bool) -> Self

Initialize an Evaluation.

source§

impl<'co, 'ro> Evaluation<'co, 'ro, Box<dyn EvalIO>>

source

pub fn new_pure() -> Self

Initialize an Evaluation, without the import statement available, and all IO operations stubbed out.

source

pub fn enable_impure(&mut self, io: Option<Box<dyn EvalIO>>)

Configure an Evaluation to have impure features available with the given I/O implementation.

If no I/O implementation is supplied, StdIO is used by default.

source

pub fn new_impure() -> Self

Initialise an Evaluation, with all impure features turned on by default.

source§

impl<'co, 'ro, IO> Evaluation<'co, 'ro, IO>
where IO: AsRef<dyn EvalIO> + 'static,

source

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.

source

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.

source

pub fn evaluate( self, code: impl AsRef<str>, location: Option<PathBuf> ) -> EvaluationResult

Evaluate 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)

Auto Trait Implementations§

§

impl<'co, 'ro, IO> !RefUnwindSafe for Evaluation<'co, 'ro, IO>

§

impl<'co, 'ro, IO> !Send for Evaluation<'co, 'ro, IO>

§

impl<'co, 'ro, IO> !Sync for Evaluation<'co, 'ro, IO>

§

impl<'co, 'ro, IO> Unpin for Evaluation<'co, 'ro, IO>
where IO: Unpin,

§

impl<'co, 'ro, IO> !UnwindSafe for Evaluation<'co, 'ro, IO>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V