Enum Context

pub enum Context {
    Value(Arc<BTreeMap<SmolStr, Value>>),
    RestrictedResidual(Arc<BTreeMap<SmolStr, Expr>>),
}

Context field of a Request

Variants

Value(Arc<BTreeMap<SmolStr, Value>>)

The context is a concrete value.

RestrictedResidual(Arc<BTreeMap<SmolStr, Expr>>)

The context is a residual expression, containing some unknown value in the record attributes. INVARIANT(restricted): Each Expr in this map must be a RestrictedExpr. INVARIANT(unknown): At least one Expr must contain an unknown.

Implementations

impl Context

pub fn empty() -> Self

Create an empty Context

pub fn from_expr( expr: BorrowedRestrictedExpr<'_>, extensions: &Extensions<'_>, ) -> Result<Self, ContextCreationError>

Create a Context from a RestrictedExpr, which must be a Record.

extensions provides the Extensions which should be active for evaluating the RestrictedExpr.

pub fn from_pairs( pairs: impl IntoIterator<Item = (SmolStr, RestrictedExpr)>, extensions: &Extensions<'_>, ) -> Result<Self, ContextCreationError>

Create a Context from a map of key to RestrictedExpr, or a Vec of (key, RestrictedExpr) pairs, or any other iterator of (key, RestrictedExpr) pairs

extensions provides the Extensions which should be active for evaluating the RestrictedExpr.

pub fn from_json_str( json: &str, ) -> Result<Self, ContextJsonDeserializationError>

Create a Context from a string containing JSON (which must be a JSON object, not any other JSON type, or you will get an error here). JSON here must use the __entity and __extn escapes for entity references, extension values, etc.

For schema-based parsing, use ContextJsonParser.

pub fn from_json_value( json: Value, ) -> Result<Self, ContextJsonDeserializationError>

Create a Context from a serde_json::Value (which must be a JSON object, not any other JSON type, or you will get an error here). JSON here must use the __entity and __extn escapes for entity references, extension values, etc.

For schema-based parsing, use ContextJsonParser.

pub fn from_json_file( json: impl Read, ) -> Result<Self, ContextJsonDeserializationError>

Create a Context from a JSON file. The JSON file must contain a JSON object, not any other JSON type, or you will get an error here. JSON here must use the __entity and __extn escapes for entity references, extension values, etc.

For schema-based parsing, use ContextJsonParser.

pub fn num_keys(&self) -> usize

Get the number of keys in this Context.

pub fn substitute( self, mapping: &HashMap<SmolStr, Value>, ) -> Result<Self, EvaluationError>

Substitute unknowns with concrete values in this context. If this is already a Context::Value, then this returns self unchanged and will not error. Otherwise delegate to Expr::substitute.

Trait Implementations

impl BoundedDisplay for Context

fn fmt(&self, f: &mut impl Write, n: Option<usize>) -> Result

Write self to the writer f, truncating set elements or key-value pairs if necessary based on n

fn fmt_bounded(&self, f: &mut impl Write, n: usize) -> Result

Convenience method, equivalent to fmt() with n as Some.

fn fmt_unbounded(&self, f: &mut impl Write) -> Result

Convenience method, equivalent to fmt() with n as None.

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.

impl Display for Context

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

Formats the value using the given formatter.

impl From<Context> for PartialValue

fn from(ctx: Context) -> PartialValue

Converts to this type from the input type.

impl From<Context> for RestrictedExpr

fn from(value: Context) -> Self

Converts to this type from the input type.

impl IntoIterator for Context

type Item = (SmolStr, RestrictedExpr)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Context

fn eq(&self, other: &Context) -> 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 Eq for Context

impl StructuralPartialEq for Context