Struct QueryPlan 

pub struct QueryPlan<E: SearchEntity> {
    pub meta: &'static EntityMeta,
    pub server_predicate: PredicateArena,
    pub server_group_predicate: PredicateArena,
    pub row_predicate: PredicateArena,
    pub group_predicate: PredicateArena,
    pub projection: Vec<FieldId>,
    pub projection_aliases: Option<Vec<&'static str>>,
    pub order: Vec<OrderBy>,
    pub paging: Paging,
    pub target: QueryTarget,
    pub distinct: bool,
    pub force_empty: bool,
    /* private fields */
}

Immutable input to a backend renderer.

Fields

meta: &'static EntityMeta

server_predicate: PredicateArena

server_group_predicate: PredicateArena

row_predicate: PredicateArena

group_predicate: PredicateArena

projection: Vec<FieldId>

projection_aliases: Option<Vec<&'static str>>

order: Vec<OrderBy>

paging: Paging

target: QueryTarget

distinct: bool

force_empty: bool

Implementations

impl<E: SearchEntity> QueryPlan<E>

pub fn new( query: &UserQuery<E>, scope: &ServerScope<E>, target: QueryTarget, ) -> Result<Self, PlanError>

pub fn new_with_scopes( query: &UserQuery<E>, scope: &ServerScope<E>, group_scope: &GroupScope<E>, target: QueryTarget, ) -> Result<Self, PlanError>

pub fn condition_order_value( &self, field: FieldId, ) -> Result<Option<&ScalarValue>, ParamError>

pub fn for_projection<P: SearchProjection<E>>( query: &UserQuery<E>, scope: &ServerScope<E>, ) -> Result<Self, PlanError>

pub const fn shape_fingerprint_seed(&self) -> u64

pub fn field_access(&self) -> &FieldAccessPolicy<E>

pub fn validate_field_access( &self, fields: impl IntoIterator<Item = FieldId>, ) -> Result<(), ParamError>

pub fn validate_predicate_access( &self, predicate: &PredicateArena, ) -> Result<(), ParamError>

Trait Implementations

impl<E: Debug + SearchEntity> Debug for QueryPlan<E>

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

Formats the value using the given formatter.