Struct trustfall_core::interpreter::DynamicallyResolvedValue

#[non_exhaustive]
pub struct DynamicallyResolvedValue<'a> { /* private fields */ }

Indicates that a property’s value is dependent on another value in the query.

If VertexInfo::dynamically_required_property() is able to determine a value for the specified property, it returns a DynamicallyResolvedValue. The specified property’s value may be different in different query results, but the way in which it varies can be determined programmatically and can be resolved to a CandidateValue for each query result.

Example

Consider the following query, which fetches emails where the sender also included their own address in the receipients:

{
    Email {
        contents @output

        sender {
            address @tag(name: "sender")
        }
        recipient {
            address @filter(op: "=", value: ["%sender"])
        }
    }
}

A naïve implementation of resolving the recipient edge would resolve all recipients for each email and rely on Trustfall to filter out recipient addresses that don’t match the sender’s address. This implementation is valid, but can be made faster.

To improve performance, the implementation could avoid loading all recipients and instead only load the recipient that matches the sender’s address (if any).

However, as the sender’s address varies from email to email, its value must be resolved dynamically, i.e. separately for each possible query result. Resolving the recipient edge might then look like this:

// Inside our adapter implementation:
// we use this method to resolve `recipient` edges.
fn resolve_recipient_edge<'a, V: AsVertex<Vertex> + 'a>(
    &self,
    contexts: ContextIterator<'a, V>,
    resolve_info: &ResolveEdgeInfo,
) -> ContextOutcomeIterator<'a, V, VertexIterator<'a, Vertex>> {
    if let Some(dynamic_value) = resolve_info.destination().dynamically_required_property("address") {
        // The query is looking for a specific recipient's address,
        // so let's look it up directly.
        dynamic_value.resolve_with(self, contexts, |vertex, candidate| {
            resolve_recipient_from_candidate_value(vertex, candidate)
        })
    } else {
        // No specific recipient address, use the general-case edge resolver logic.
        resolve_recipient_otherwise(contexts)
    }
}

Implementations

impl<'a> DynamicallyResolvedValue<'a>

pub fn resolve<'vertex, AdapterT: Adapter<'vertex>, V: AsVertex<AdapterT::Vertex> + 'vertex>( self, adapter: &AdapterT, contexts: ContextIterator<'vertex, V> ) -> ContextOutcomeIterator<'vertex, V, CandidateValue<FieldValue>>

pub fn resolve_with<'vertex, AdapterT: Adapter<'vertex>, V: AsVertex<AdapterT::Vertex> + 'vertex>( self, adapter: &AdapterT, contexts: ContextIterator<'vertex, V>, neighbor_resolver: impl FnMut(&AdapterT::Vertex, CandidateValue<FieldValue>) -> VertexIterator<'vertex, AdapterT::Vertex> + 'vertex ) -> ContextOutcomeIterator<'vertex, V, VertexIterator<'vertex, AdapterT::Vertex>>

Trait Implementations

impl<'a> Clone for DynamicallyResolvedValue<'a>

fn clone(&self) -> DynamicallyResolvedValue<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DynamicallyResolvedValue<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for DynamicallyResolvedValue<'a>

fn eq(&self, other: &DynamicallyResolvedValue<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Eq for DynamicallyResolvedValue<'a>

impl<'a> StructuralEq for DynamicallyResolvedValue<'a>

impl<'a> StructuralPartialEq for DynamicallyResolvedValue<'a>