Skip to main content

Query

dioxus_query::query

Struct Query 

Source 
pub struct Query<Q: QueryCapability> { /* private fields */ }

Implementations§

Source§

impl<Q: QueryCapability> Query<Q>

Source

pub fn new(keys: Q::Keys, query: Q) -> Self

Source

pub fn enable(self, enabled: bool) -> Self

Enable or disable this query so that it doesnt automatically run.

Defaults to true.

Source

pub fn stale_time(self, stale_time: Duration) -> Self

For how long is the data considered stale. If a query subscriber is mounted and the data is stale, it will re run the query otherwise it return the cached data.

Defaults to Duration::ZERO, meaning it is marked stale immediately after it has been used.

Source

pub fn clean_time(self, clean_time: Duration) -> Self

For how long the data is kept cached after there are no more query subscribers.

Defaults to 5min, meaning it clears automatically after 5 minutes of no subscribers to it.

Source

pub fn interval_time(self, interval_time: Duration) -> Self

Every how often the query reruns.

Defaults to Duration::MAX, meaning it never re runs automatically.

Note: If multiple subscribers of the same query use different intervals, only the shortest one will be used.

Trait Implementations§

Source§

impl<Q: Clone + QueryCapability> Clone for Query<Q>
where Q::Keys: Clone,

Source§

fn clone(&self) -> Query<Q>

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

impl<Q: QueryCapability> Eq for Query<Q>

Source§

impl<Q: QueryCapability> From<GetQuery<Q>> for Query<Q>

Source§

fn from(value: GetQuery<Q>) -> Self

Converts to this type from the input type.
Source§

impl<Q: QueryCapability> Hash for Query<Q>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Q: PartialEq + QueryCapability> PartialEq for Query<Q>
where Q::Keys: PartialEq,

Source§

fn eq(&self, other: &Query<Q>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<Q: PartialEq + QueryCapability> StructuralPartialEq for Query<Q>
where Q::Keys: PartialEq,

Auto Trait Implementations§

§

impl<Q> Freeze for Query<Q>
where Q: Freeze, <Q as QueryCapability>::Keys: Freeze,

§

impl<Q> RefUnwindSafe for Query<Q>
where Q: RefUnwindSafe, <Q as QueryCapability>::Keys: RefUnwindSafe,

§

impl<Q> Send for Query<Q>
where Q: Send, <Q as QueryCapability>::Keys: Send,

§

impl<Q> Sync for Query<Q>
where Q: Sync, <Q as QueryCapability>::Keys: Sync,

§

impl<Q> Unpin for Query<Q>
where Q: Unpin, <Q as QueryCapability>::Keys: Unpin,

§

impl<Q> UnsafeUnpin for Query<Q>
where Q: UnsafeUnpin, <Q as QueryCapability>::Keys: UnsafeUnpin,

§

impl<Q> UnwindSafe for Query<Q>
where Q: UnwindSafe, <Q as QueryCapability>::Keys: UnwindSafe,

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> 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> DependencyElement for T
where T: 'static + PartialEq + Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
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 = !

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