Skip to main content

WindowedQueryWatch

myko::client

Struct WindowedQueryWatch 

Source 
pub struct WindowedQueryWatch<T: CellValue> { /* private fields */ }
Expand description

A live ordered query page with authoritative pagination metadata.

Implementations§

Source§

impl<T: CellValue> WindowedQueryWatch<T>

Source

pub const fn items(&self) -> &Cell<Vec<Arc<T>>, CellImmutable>

Source

pub const fn ready(&self) -> &Cell<bool, CellImmutable>

Source

pub const fn total_count(&self) -> &Cell<Option<usize>, CellImmutable>

Source

pub const fn window(&self) -> &Cell<Option<QueryWindow>, CellImmutable>

Source

pub const fn state(&self) -> &Cell<WindowedQueryState<T>, CellImmutable>

One coherent reactive value for rendering the page and its controls.

Source

pub fn set_window(&self, window: Option<QueryWindow>) -> Result<(), String>

Move this live subscription to another window without resubscribing.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn set_cursor_window(&self, window: QueryCursorWindow) -> Result<(), String>

Move this live subscription to an exclusive ID-keyset page.

§Errors

Returns an error for an invalid cursor or when encoding fails.

Source

pub fn first_cursor_page(&self, limit: usize) -> Result<(), String>

Request the first keyset page.

§Errors

Returns an error when encoding the control message fails.

Source

pub fn next_cursor_page(&self, limit: usize) -> Result<bool, String>
where T: WithId,

Request the keyset page immediately after the last visible item.

§Errors

Returns an error when encoding the control message fails.

Source

pub fn previous_cursor_page(&self, limit: usize) -> Result<bool, String>
where T: WithId,

Request the keyset page immediately before the first visible item.

§Errors

Returns an error when encoding the control message fails.

Source

pub fn set_page(&self, offset: usize, limit: usize) -> Result<(), String>

Select a page using an absolute offset and limit.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn next_page(&self) -> Result<bool, String>

Request the next page when the acknowledged window has more rows.

Returns Ok(false) when pagination metadata is not ready or the watch is already on its final page.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn previous_page(&self) -> Result<bool, String>

Request the previous page when the acknowledged window is not first.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn first_page(&self) -> Result<bool, String>

Request the first page when the acknowledged window is not first.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn set_page_index(&self, page_index: usize) -> Result<bool, String>

Request a zero-based page index when it is within the known result set.

§Errors

Returns an error if the control message cannot be encoded.

Source

pub fn last_page(&self) -> Result<bool, String>

Request the final page when its position is known and not already active.

§Errors

Returns an error if the control message cannot be encoded.

Trait Implementations§

Source§

impl<T: Clone + CellValue> Clone for WindowedQueryWatch<T>

Source§

fn clone(&self) -> WindowedQueryWatch<T>

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> JoinKeyFrom<T> for T
where T: Clone,

Source§

fn join_key_from(value: &T) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> RegisteredType for T
where T: 'static,

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 = 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more