Struct Value

pub struct Value {
    pub value: ValueKind,
    pub loc: Option<Loc>,
}

This describes all the values which could be the dynamic result of evaluating an Expr. Cloning is O(1).

Fields

value: ValueKind

Underlying actual value

loc: Option<Loc>

Source location associated with the value, if any

Implementations

impl Value

pub fn empty_set(loc: Option<Loc>) -> Self

Create a new empty set

pub fn empty_record(loc: Option<Loc>) -> Self

Create a new empty record

pub fn new(value: impl Into<ValueKind>, loc: Option<Loc>) -> Self

Create a Value from anything that implements Into<ValueKind> and an optional source location

pub fn set(vals: impl IntoIterator<Item = Value>, loc: Option<Loc>) -> Self

Create a set with the given Values as elements

pub fn set_of_lits( lits: impl IntoIterator<Item = Literal>, loc: Option<Loc>, ) -> Self

Create a set with the given Literals as elements

the resulting Value will have the given loc attached, but its individual Literal elements will not have a source loc attached

pub fn record<K: Into<SmolStr>, V: Into<Value>>( pairs: impl IntoIterator<Item = (K, V)>, loc: Option<Loc>, ) -> Self

Create a record with the given (key, value) pairs

pub fn record_arc( pairs: Arc<BTreeMap<SmolStr, Value>>, loc: Option<Loc>, ) -> Self

Create a record with the given attributes/value mapping.

pub fn with_maybe_source_loc(self, loc: Option<Loc>) -> Self

Return the Value, but with the given Loc (or None)

pub fn value_kind(&self) -> &ValueKind

Get the ValueKind for this Value

pub fn source_loc(&self) -> Option<&Loc>

Get the Loc attached to this Value, if there is one

pub fn eq_and_same_source_loc(&self, other: &Self) -> bool

The PartialEq and Eq implementations for Value ignore the source location. If you actually want to check that two values are equal and have the same source location, you can use this.

Trait Implementations

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<T: Into<Literal>> From<T> for Value

Create a Value directly from a Literal, or from anything that implements Into<Literal> (so Integer, &str, EntityUID, etc)

This impl does not propagate source location; the resulting Value will have no source location info attached

fn from(lit: T) -> Self

Converts to this type from the input type.

impl From<Value> for Expr

fn from(v: Value) -> Self

Converts to this type from the input type.

impl From<Value> for RestrictedExpr

fn from(value: Value) -> RestrictedExpr

Converts to this type from the input type.

impl<T: Into<Value>> From<Vec<T>> for Value

Create a Value directly from a Vec<Value>, or Vec<T> where T: Into<Value> (so Vec<Integer>, Vec<String>, etc)

This impl does not propagate source location; the resulting Value will have no source location info attached

fn from(v: Vec<T>) -> Self

Converts to this type from the input type.

impl FromIterator<Value> for Set

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl Ord for Value

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Value

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticallyTyped for Value

fn type_of(&self) -> Type

Get the object’s type

impl TryFrom<Expr> for Value

type Error = NotValue

The type returned in the event of a conversion error.

fn try_from(expr: Expr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PartialValue> for Value

type Error = PartialValueToValueError

The type returned in the event of a conversion error.

fn try_from(value: PartialValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value