Struct QueryPlan

Source

pub struct QueryPlan<E>where
    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 */
}

Expand description

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

Struct QueryPlan Copy item path

Fields§

Implementations§

impl<E> QueryPlan<E>where E: SearchEntity,

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

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

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

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

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 for QueryPlan<E>where E: Debug + SearchEntity,

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

Auto Trait Implementations§

impl<E> Freeze for QueryPlan<E>where FieldAccessPolicy<E>: Freeze, PhantomData<fn() -> E>: Freeze,

impl<E> RefUnwindSafe for QueryPlan<E>where FieldAccessPolicy<E>: RefUnwindSafe, PhantomData<fn() -> E>: RefUnwindSafe,

impl<E> Send for QueryPlan<E>where FieldAccessPolicy<E>: Send, PhantomData<fn() -> E>: Send,

impl<E> Sync for QueryPlan<E>where FieldAccessPolicy<E>: Sync, PhantomData<fn() -> E>: Sync,

impl<E> Unpin for QueryPlan<E>where FieldAccessPolicy<E>: Unpin, PhantomData<fn() -> E>: Unpin,

impl<E> UnsafeUnpin for QueryPlan<E>where FieldAccessPolicy<E>: UnsafeUnpin, PhantomData<fn() -> E>: UnsafeUnpin,

impl<E> UnwindSafe for QueryPlan<E>where FieldAccessPolicy<E>: UnwindSafe, PhantomData<fn() -> E>: UnwindSafe,

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> Same for T

type Output = T

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

type Error = !

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

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct QueryPlan

impl<E> QueryPlan<E>
where E: SearchEntity,

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

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

impl<E> Freeze for QueryPlan<E>
where FieldAccessPolicy<E>: Freeze, PhantomData<fn() -> E>: Freeze,

impl<E> RefUnwindSafe for QueryPlan<E>
where FieldAccessPolicy<E>: RefUnwindSafe, PhantomData<fn() -> E>: RefUnwindSafe,

impl<E> Send for QueryPlan<E>
where FieldAccessPolicy<E>: Send, PhantomData<fn() -> E>: Send,

impl<E> Sync for QueryPlan<E>
where FieldAccessPolicy<E>: Sync, PhantomData<fn() -> E>: Sync,

impl<E> Unpin for QueryPlan<E>
where FieldAccessPolicy<E>: Unpin, PhantomData<fn() -> E>: Unpin,

impl<E> UnsafeUnpin for QueryPlan<E>
where FieldAccessPolicy<E>: UnsafeUnpin, PhantomData<fn() -> E>: UnsafeUnpin,

impl<E> UnwindSafe for QueryPlan<E>
where FieldAccessPolicy<E>: UnwindSafe, PhantomData<fn() -> E>: UnwindSafe,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,