Struct QueryPlanSummary 

pub struct QueryPlanSummary {
    pub root_entity: String,
    pub fields: Vec<String>,
    pub filter_description: Option<String>,
    pub filter_selectivity: Option<f64>,
    pub includes: Vec<IncludeSummary>,
    pub budget: BudgetSummary,
    pub order_by: Vec<OrderSummary>,
    pub pagination: Option<PaginationSummary>,
}

Summary of a query plan.

Fields

root_entity: String

Root entity being queried.

fields: Vec<String>

Fields being projected (empty means all fields).

filter_description: Option<String>

Filter description (if any).

filter_selectivity: Option<f64>

Filter selectivity estimate (0.0-1.0).

includes: Vec<IncludeSummary>

Include plans for related entities.

budget: BudgetSummary

Fanout budget constraints.

order_by: Vec<OrderSummary>

Ordering specification.

pagination: Option<PaginationSummary>

Pagination parameters.

Implementations

impl QueryPlanSummary

pub fn new(root_entity: impl Into<String>) -> Self

Create a new query plan summary.

pub fn with_fields(self, fields: Vec<String>) -> Self

Set the fields to project.

pub fn with_filter(self, description: String, selectivity: f64) -> Self

Set the filter description.

pub fn with_include(self, include: IncludeSummary) -> Self

Add an include.

pub fn with_budget(self, budget: BudgetSummary) -> Self

Set the budget.

Trait Implementations

impl Archive for QueryPlanSummary

where String: Archive, Vec<String>: Archive, Option<String>: Archive, Option<f64>: Archive, Vec<IncludeSummary>: Archive, BudgetSummary: Archive, Vec<OrderSummary>: Archive, Option<PaginationSummary>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedQueryPlanSummary

The archived representation of this type.

type Resolver = QueryPlanSummaryResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for QueryPlanSummary

fn clone(&self) -> QueryPlanSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryPlanSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryPlanSummary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<QueryPlanSummary, __D> for Archived<QueryPlanSummary>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Vec<String>: Archive, <Vec<String> as Archive>::Archived: Deserialize<Vec<String>, __D>, Option<String>: Archive, <Option<String> as Archive>::Archived: Deserialize<Option<String>, __D>, Option<f64>: Archive, <Option<f64> as Archive>::Archived: Deserialize<Option<f64>, __D>, Vec<IncludeSummary>: Archive, <Vec<IncludeSummary> as Archive>::Archived: Deserialize<Vec<IncludeSummary>, __D>, BudgetSummary: Archive, <BudgetSummary as Archive>::Archived: Deserialize<BudgetSummary, __D>, Vec<OrderSummary>: Archive, <Vec<OrderSummary> as Archive>::Archived: Deserialize<Vec<OrderSummary>, __D>, Option<PaginationSummary>: Archive, <Option<PaginationSummary> as Archive>::Archived: Deserialize<Option<PaginationSummary>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<QueryPlanSummary, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl PartialEq for QueryPlanSummary

fn eq(&self, other: &QueryPlanSummary) -> 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<__S: Fallible + ?Sized> Serialize<__S> for QueryPlanSummary

where String: Serialize<__S>, Vec<String>: Serialize<__S>, Option<String>: Serialize<__S>, Option<f64>: Serialize<__S>, Vec<IncludeSummary>: Serialize<__S>, BudgetSummary: Serialize<__S>, Vec<OrderSummary>: Serialize<__S>, Option<PaginationSummary>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for QueryPlanSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueryPlanSummary