Skip to main content

QueryPlan

Struct QueryPlan 

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

A reusable, invocation-free typed read program.

Implementations§

Source§

impl QueryPlan

Source

pub fn new( bindings: Vec<AssertionBinding>, inputs: Vec<InputColumn>, pipeline: Vec<ReadStage>, output: QueryOutput, managed_semantics: ManagedSemanticSchemaFingerprint, ) -> Result<Self, Diagnostic>

Validate and construct one canonical plan under fixed protocol limits.

Source

pub fn new_with_functions( bindings: Vec<AssertionBinding>, functions: Vec<LocalFunction>, inputs: Vec<InputColumn>, pipeline: Vec<ReadStage>, output: QueryOutput, managed_semantics: ManagedSemanticSchemaFingerprint, ) -> Result<Self, Diagnostic>

Validate and construct one plan carrying plan-local functions.

Source

pub fn new_v2( bindings: Vec<AssertionBinding>, inputs: Vec<InputColumn>, pipeline: Vec<ReadStage>, output: QueryOutput, managed_semantics: ManagedSemanticSchemaFingerprint, ) -> Result<Self, Diagnostic>

Validate and construct one additive V2 low-level plan.

This constructor carries the required empty V2 compatibility object; there is no host-controlled format switch or legacy mode.

Source

pub fn new_v2_with_functions( bindings: Vec<AssertionBinding>, functions: Vec<LocalFunction>, inputs: Vec<InputColumn>, pipeline: Vec<ReadStage>, output: QueryOutput, compatibility: QueryPlanV2Compatibility, managed_semantics: ManagedSemanticSchemaFingerprint, ) -> Result<Self, Diagnostic>

Validate and construct one additive V2 plan with local functions and an explicit Rust-owned compatibility contract.

Source

pub fn check_structural_limits( &self, limits: StructuralLimits, ) -> Result<(), Diagnostic>

Re-check this plan’s whole structure under caller-supplied limits.

The exact construction-time traversal runs again — bindings, inputs, the root pipeline, and every local function under one aggregate predicate-node budget — so a caller passing stricter StructuralLimits gets every field enforced, not a subset.

Source

pub fn format(&self) -> &str

Return the exact wire format discriminator.

Source

pub fn bindings(&self) -> &[AssertionBinding]

Return dense binding declarations.

Source

pub const fn v2_compatibility(&self) -> Option<&QueryPlanV2Compatibility>

Return the additive V2 compatibility contract.

V1 plans return None; every V2 plan returns Some, including native low-level plans whose compatibility object is empty.

Source

pub fn inputs(&self) -> &[InputColumn]

Return dense typed input column declarations.

Source

pub fn functions(&self) -> &[LocalFunction]

Return the plan-local functions.

Source

pub fn pipeline(&self) -> &[ReadStage]

Return the ordered read pipeline.

Source

pub const fn output(&self) -> &QueryOutput

Return the explicit output category.

Source

pub const fn managed_semantics(&self) -> &ManagedSemanticSchemaFingerprint

Return the exact managed semantics this plan was authored against.

Source

pub const fn required_capabilities(&self) -> &CapabilitySet

Return open capabilities derived from syntax, never named manually.

Source

pub fn canonical_bytes(&self) -> Result<Vec<u8>, Diagnostic>

Encode exact canonical bytes.

Source

pub fn fingerprint(&self) -> Result<QueryPlanFingerprint, Diagnostic>

Compute the canonical domain-separated plan fingerprint.

Trait Implementations§

Source§

impl Clone for QueryPlan

Source§

fn clone(&self) -> Self

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 Eq for QueryPlan

Source§

impl PartialEq for QueryPlan

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for QueryPlan

Source§

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

Serialize this value into the given Serde serializer. Read more
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
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.