Skip to main content

QueryPlan

Struct QueryPlan 

Source
pub struct QueryPlan { /* private fields */ }
Expand description

Language-neutral executable query plan.

Implementations§

Source§

impl QueryPlan

Source

pub fn new(operation: QueryOperation, resource: impl Into<String>) -> Self

Starts a plan for operation over the canonical resource name.

Source

pub fn add_projection(&mut self, field: impl Into<String>)

Appends a canonical field to the response projection.

Source

pub fn set_filter(&mut self, filter: QueryFilter)

Replaces the boolean filter.

Source

pub fn add_order(&mut self, order: QueryOrder)

Appends an ordering entry.

Source

pub const fn set_pagination(&mut self, limit: Option<u64>, offset: Option<u64>)

Sets result pagination.

Source

pub fn add_group_by(&mut self, field: impl Into<String>)

Appends a canonical grouping field.

Source

pub fn add_aggregate(&mut self, aggregate: QueryAggregate)

Appends an aggregate projection.

Source

pub fn set_mutation_value( &mut self, field: impl Into<String>, value: QueryValue, )

Sets a canonical mutation assignment.

Source

pub fn add_source_evidence(&mut self, evidence: QuerySourceEvidence)

Attaches source evidence to the plan.

Source

pub const fn operation(&self) -> QueryOperation

Operation.

Source

pub fn resource(&self) -> &str

Canonical resource name.

Source

pub fn projection(&self) -> &[String]

Canonical projected fields in response order.

Source

pub const fn filter(&self) -> Option<&QueryFilter>

Boolean filter.

Source

pub fn order(&self) -> &[QueryOrder]

Ordering entries.

Source

pub const fn limit(&self) -> Option<u64>

Maximum result count.

Source

pub const fn offset(&self) -> Option<u64>

Result offset.

Source

pub fn group_by(&self) -> &[String]

Canonical grouping fields.

Source

pub fn aggregates(&self) -> &[QueryAggregate]

Aggregate projections.

Source

pub const fn mutation(&self) -> &BTreeMap<String, QueryValue>

Canonical mutation assignments.

Source

pub fn source_evidence(&self) -> &[QuerySourceEvidence]

Source ranges retained by the frontend adapter.

Source

pub const fn authorization(&self) -> QueryAuthorization

Lowering validates meaning but never authorizes execution.

Source

pub fn canonical_value(&self) -> Value

Returns the provenance-free canonical JSON value used to compare plans produced by different query languages.

Source

pub fn canonical_json(&self) -> String

Deterministic provenance-free serialization for cross-frontend conformance checks.

Trait Implementations§

Source§

impl Clone for QueryPlan

Source§

fn clone(&self) -> QueryPlan

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryPlan

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for QueryPlan

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for QueryPlan

Auto Trait Implementations§

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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.
§

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

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,