This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.

yew_agent/oneshot/
hooks.rs

1use yew::prelude::*;
2
3use super::provider::OneshotProviderState;
4use super::Oneshot;
5
6/// Hook handle for [`use_oneshot_runner`]
7#[derive(Debug)]
8pub struct UseOneshotRunnerHandle<T>
9where
10    T: Oneshot + 'static,
11{
12    state: OneshotProviderState<T>,
13}
14
15impl<T> UseOneshotRunnerHandle<T>
16where
17    T: Oneshot + 'static,
18{
19    /// Runs an oneshot agent.
20    pub async fn run(&self, input: T::Input) -> T::Output {
21        self.state.create_bridge().run(input).await
22    }
23}
24
25impl<T> Clone for UseOneshotRunnerHandle<T>
26where
27    T: Oneshot + 'static,
28{
29    fn clone(&self) -> Self {
30        Self {
31            state: self.state.clone(),
32        }
33    }
34}
35
36impl<T> PartialEq for UseOneshotRunnerHandle<T>
37where
38    T: Oneshot,
39{
40    fn eq(&self, rhs: &Self) -> bool {
41        self.state == rhs.state
42    }
43}
44
45/// A hook to create a runner to an oneshot agent.
46#[hook]
47pub fn use_oneshot_runner<T>() -> UseOneshotRunnerHandle<T>
48where
49    T: Oneshot + 'static,
50{
51    let state = use_context::<OneshotProviderState<T>>().expect("failed to find worker context");
52
53    UseOneshotRunnerHandle { state }
54}