Enum tvix_eval::Value

pub enum Value {
    Null,
    Bool(bool),
    Integer(i64),
    Float(f64),
    String(NixString),
    Path(Box<PathBuf>),
    Attrs(Box<NixAttrs>),
    List(NixList),
    Closure(Rc<Closure>),
    Builtin(Builtin),
    Thunk(Thunk),
    AttrNotFound,
    Blueprint(Rc<Lambda>),
    DeferredUpvalue(StackIdx),
    UnresolvedPath(Box<PathBuf>),
    Json(Value),
    FinaliseRequest(bool),
    Catchable(CatchableErrorKind),
}

Variants

Null

Bool(bool)

Integer(i64)

Float(f64)

String(NixString)

Path(Box<PathBuf>)

Attrs(Box<NixAttrs>)

List(NixList)

Closure(Rc<Closure>)

Builtin(Builtin)

Thunk(Thunk)

AttrNotFound

Blueprint(Rc<Lambda>)

DeferredUpvalue(StackIdx)

UnresolvedPath(Box<PathBuf>)

Json(Value)

FinaliseRequest(bool)

Catchable(CatchableErrorKind)

Implementations

impl Value

pub(crate) async fn into_json( self, co: &GenCo ) -> Result<Result<Json, CatchableErrorKind>, ErrorKind>

pub(crate) async fn into_json_generator( self, co: GenCo ) -> Result<Value, ErrorKind>

Generator version of the above, which wraps responses in Value::Json.

impl Value

Constructors

pub fn attrs(attrs: NixAttrs) -> Self

Construct a Value::Attrs from a NixAttrs.

impl Value

pub(crate) async fn deep_force( self, co: GenCo, thunk_set: SharedThunkSet ) -> Result<Value, ErrorKind>

Deeply forces a value, traversing e.g. lists and attribute sets and forcing their contents, too.

This is a generator function.

pub async fn coerce_to_string( self, co: GenCo, kind: CoercionKind ) -> Result<Value, ErrorKind>

Coerce a Value to a string. See CoercionKind for a rundown of what input types are accepted under what circumstances.

pub(crate) async fn nix_eq( self, other: Value, co: GenCo, ptr_eq: PointerEquality ) -> Result<Value, ErrorKind>

Compare two Nix values for equality, forcing nested parts of the structure as needed.

This comparison needs to be invoked for nested values (e.g. in lists and attribute sets) as well, which is done by suspending and asking the VM to perform the nested comparison.

The top_level parameter controls whether this invocation is the top-level comparison, or a nested value comparison. See //tvix/docs/value-pointer-equality.md

pub fn type_of(&self) -> &'static str

pub fn as_bool(&self) -> Result<bool, ErrorKind>

pub fn as_int(&self) -> Result<i64, ErrorKind>

pub fn as_float(&self) -> Result<f64, ErrorKind>

pub fn to_str(&self) -> Result<NixString, ErrorKind>

pub fn to_path(&self) -> Result<Box<PathBuf>, ErrorKind>

pub fn to_attrs(&self) -> Result<Box<NixAttrs>, ErrorKind>

pub fn to_list(&self) -> Result<NixList, ErrorKind>

pub fn as_closure(&self) -> Result<Rc<Closure>, ErrorKind>

pub fn as_list_mut(&mut self) -> Result<&mut NixList, ErrorKind>

pub fn is_path(&self) -> bool

pub fn is_number(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn is_attrs(&self) -> bool

pub async fn nix_cmp_ordering( self, other: Self, co: GenCo ) -> Result<Option<Ordering>, ErrorKind>

Compare self against other using (fallible) Nix ordering semantics.

Note that as this returns an Option<Ordering> it can not directly be used as a generator function in the VM. The exact use depends on the callsite, as the meaning is interpreted in different ways e.g. based on the comparison operator used.

The function is intended to be used from within other generator functions or gen! blocks.

async fn nix_cmp_ordering_( myself: Self, other: Self, co: GenCo ) -> Result<Option<Ordering>, ErrorKind>

pub async fn force(self, co: GenCo, span: LightSpan) -> Result<Value, ErrorKind>

pub fn explain(&self) -> String

Explain a value in a human-readable way, e.g. by presenting the docstrings of functions if present.

Trait Implementations

impl Arbitrary for Value

type Parameters = Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Value>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl From<CatchableErrorKind> for Value

fn from(c: CatchableErrorKind) -> Value

Converts to this type from the input type.

impl From<PathBuf> for Value

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl<V> From<Result<V, CatchableErrorKind>> for Valuewhere Value: From<V>,

fn from(v: Result<V, CatchableErrorKind>) -> Value

Converts to this type from the input type.

impl<T> From<T> for Valuewhere T: Into<NixString>,

fn from(t: T) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(i: f64) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(i: i64) -> Self

Converts to this type from the input type.

impl TotalDisplay for Value

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