Context

Struct Context 

Source
pub struct Context<'a, E: EntityKind> {
    pub db: &'a Db<E::Canister>,
    /* private fields */
}
Expand description

Context

Fields§

§db: &'a Db<E::Canister>

Implementations§

Source§

impl<'a, E> Context<'a, E>
where E: EntityKind,

Source

pub const fn new(db: &'a Db<E::Canister>) -> Self

Source

pub fn with_store<R>(&self, f: impl FnOnce(&DataStore) -> R) -> Result<R, Error>

Source

pub fn with_store_mut<R>( &self, f: impl FnOnce(&mut DataStore) -> R, ) -> Result<R, Error>

Source

pub fn candidates_from_plan( &self, plan: QueryPlan, ) -> Result<Vec<DataKey>, Error>

Analyze Plan

Source

pub fn rows_from_plan(&self, plan: QueryPlan) -> Result<Vec<DataRow>, Error>

Source

pub fn rows_from_plan_with_pagination( &self, plan: QueryPlan, offset: u32, limit: Option<u32>, ) -> Result<Vec<DataRow>, Error>

Fetch rows with pagination applied as early as possible (pre-deserialization), only when no additional filtering or sorting is required by the executor.

Source

pub fn deserialize_rows( &self, rows: Vec<DataRow>, ) -> Result<Vec<(Key, E)>, Error>

Deserialize raw data rows into typed entity rows, mapping DataKey(Key, E).

Auto Trait Implementations§

§

impl<'a, E> Freeze for Context<'a, E>

§

impl<'a, E> RefUnwindSafe for Context<'a, E>

§

impl<'a, E> Send for Context<'a, E>
where E: Send, <E as EntityKind>::Canister: Sync,

§

impl<'a, E> Sync for Context<'a, E>
where E: Sync, <E as EntityKind>::Canister: Sync,

§

impl<'a, E> Unpin for Context<'a, E>
where E: Unpin,

§

impl<'a, E> UnwindSafe for Context<'a, E>

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