Struct UseQueryHandle

pub struct UseQueryHandle<T>
where
    T: Query + 'static,
{ /* private fields */ }

Available on crate feature query only.

A handle returned by use_query.

Implementations

impl<T> UseQueryHandle<T>

where T: Query + 'static,

pub fn state(&self) -> &QueryState<T>

Returns the state of current query.

pub async fn refresh(&self) -> QueryResult<T>

Refreshes the query.

The query will be refreshed with the input provided to the hook.

Methods from Deref<Target = QueryResult<T>>

pub fn is_ok(&self) -> bool

Returns true if the result is Ok.

Examples

let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_ok(), true);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_ok(), false);

pub fn is_err(&self) -> bool

Returns true if the result is Err.

Examples

let x: Result<i32, &str> = Ok(-3);
assert_eq!(x.is_err(), false);

let x: Result<i32, &str> = Err("Some error message");
assert_eq!(x.is_err(), true);

pub fn as_ref(&self) -> Result<&T, &E>

Converts from &Result<T, E> to Result<&T, &E>.

Produces a new Result, containing a reference into the original, leaving the original in place.

Examples

let x: Result<u32, &str> = Ok(2);
assert_eq!(x.as_ref(), Ok(&2));

let x: Result<u32, &str> = Err("Error");
assert_eq!(x.as_ref(), Err(&"Error"));

pub fn as_deref(&self) -> Result<&<T as Deref>::Target, &E>

where T: Deref,

Converts from Result<T, E> (or &Result<T, E>) to Result<&<T as Deref>::Target, &E>.

Coerces the Ok variant of the original Result via Deref and returns the new Result.

Examples

let x: Result<String, u32> = Ok("hello".to_string());
let y: Result<&str, &u32> = Ok("hello");
assert_eq!(x.as_deref(), y);

let x: Result<String, u32> = Err(42);
let y: Result<&str, &u32> = Err(&42);
assert_eq!(x.as_deref(), y);

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

The iterator yields one value if the result is Result::Ok, otherwise none.

Examples

let x: Result<u32, &str> = Ok(7);
assert_eq!(x.iter().next(), Some(&7));

let x: Result<u32, &str> = Err("nothing!");
assert_eq!(x.iter().next(), None);

Trait Implementations

impl<T> Clone for UseQueryHandle<T>

where T: Query + 'static,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for UseQueryHandle<T>

where T: Query + Debug + 'static,

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

Formats the value using the given formatter.

impl<T> Deref for UseQueryHandle<T>

where T: Query + 'static,

type Target = Result<Rc<T>, <T as Query>::Error>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.