Skip to main content

LiveQuery

Struct LiveQuery 

Source
pub struct LiveQuery<T, E> { /* private fields */ }
Expand description

A subscription’s results and lifetime; dropping it ends future runs. Its results fail with E, the query closure’s own error type.

Implementations§

Source§

impl<T, E> LiveQuery<T, E>
where T: Send + 'static, E: CarriesBug + Send + 'static,

Source

pub fn new(inner: ReconfigurableLiveQuery<(), T, E>) -> LiveQuery<T, E>

The query inner runs, with no request to replace.

Source

pub fn changed(&self) -> impl Future<Output = ()> + Send + 'static

Resolves once next_blocking has something to do: a commit changed what the last run read, the handle failed or closed, the query ended, or no run has answered yet. Dropping it loses nothing, and it needs no runtime.

Source

pub fn run_changed(&mut self) -> Option<Result<T, E>>
where T: Clone + PartialEq,

Runs the query once if a commit changed what its last run read or no run has answered yet. Returns None when nothing changed, when a write-caused result equals the last one, and once the query has ended. Never parks.

Source

pub fn has_ended(&self) -> bool

Whether the database closed, the handle failed or a run’s error carried a bug, and a result said so: the query answers nothing more.

Source

pub fn next_blocking(&mut self) -> Option<Result<T, E>>
where T: Clone + PartialEq,

Returns the first result at once, and after that only results that changed. The call parks this thread until changed would resolve, then runs the query on it. Errors remain results and don’t end the query, except the one reporting that the database closed, the handle failed or a run’s error carries a bug, as a panic’s does: after it, None.

Source

pub async fn next_inline(&mut self) -> Option<Result<T, E>>
where T: Clone + PartialEq,

next_blocking for a test on an async executor.

Source

pub fn bugs(&self) -> &Arc<dyn BugSink> ⓘ

Where a bug in a result nobody waits for any more goes (E15).

Source

pub fn runs(&self) -> LiveQueryRuns

How often this query has run so far.

Source

pub fn is_marked_for_rerun(&self) -> bool

Whether a commit since this idle query’s last result changes what it reads, so asking for its next result runs it again, with no waiting.

Source

pub fn process<P, U>(self, process: P) -> LiveQuery<U, E>
where T: Clone + PartialEq, P: Fn(T) -> Result<U, E> + Send + Sync + 'static, U: Send + 'static,

Process each value after its run has released its connection. Equality is tested on the processed value.

Auto Trait Implementations§

§

impl<T, E> !RefUnwindSafe for LiveQuery<T, E>

§

impl<T, E> !UnwindSafe for LiveQuery<T, E>

§

impl<T, E> Freeze for LiveQuery<T, E>
where T: Freeze,

§

impl<T, E> Send for LiveQuery<T, E>
where T: Send,

§

impl<T, E> Sync for LiveQuery<T, E>
where T: Sync,

§

impl<T, E> Unpin for LiveQuery<T, E>
where T: Unpin,

§

impl<T, E> UnsafeUnpin for LiveQuery<T, E>
where T: UnsafeUnpin,

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
§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> 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 = !

The type returned in the event of a conversion error.
Source§

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

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

impl<T> WithSubscriber for T

§

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
§

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

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