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

yew_agent/reactor/
provider.rs

1use std::any::type_name;
2use std::cell::RefCell;
3use std::fmt;
4use std::rc::Rc;
5
6use gloo_worker::reactor::ReactorScoped;
7use serde::{Deserialize, Serialize};
8use yew::prelude::*;
9
10use super::{Reactor, ReactorBridge, ReactorSpawner};
11use crate::utils::get_next_id;
12use crate::worker::WorkerProviderProps;
13use crate::{Bincode, Codec, Reach};
14
15pub(crate) struct ReactorProviderState<T>
16where
17    T: Reactor + 'static,
18{
19    id: usize,
20    spawn_bridge_fn: Rc<dyn Fn() -> ReactorBridge<T>>,
21    reach: Reach,
22    held_bridge: Rc<RefCell<Option<ReactorBridge<T>>>>,
23}
24
25impl<T> fmt::Debug for ReactorProviderState<T>
26where
27    T: Reactor,
28{
29    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
30        f.write_str(type_name::<Self>())
31    }
32}
33
34impl<T> ReactorProviderState<T>
35where
36    T: Reactor,
37{
38    fn get_held_bridge(&self) -> ReactorBridge<T> {
39        let mut held_bridge = self.held_bridge.borrow_mut();
40
41        match held_bridge.as_mut() {
42            Some(m) => m.fork(),
43            None => {
44                let bridge = (self.spawn_bridge_fn)();
45                *held_bridge = Some(bridge.fork());
46                bridge
47            }
48        }
49    }
50
51    /// Creates a bridge, uses "fork" for public agents.
52    pub fn create_bridge(&self) -> ReactorBridge<T> {
53        match self.reach {
54            Reach::Public => {
55                let held_bridge = self.get_held_bridge();
56                held_bridge.fork()
57            }
58            Reach::Private => (self.spawn_bridge_fn)(),
59        }
60    }
61}
62
63impl<T> Clone for ReactorProviderState<T>
64where
65    T: Reactor,
66{
67    fn clone(&self) -> Self {
68        Self {
69            id: self.id,
70            spawn_bridge_fn: self.spawn_bridge_fn.clone(),
71            reach: self.reach,
72            held_bridge: self.held_bridge.clone(),
73        }
74    }
75}
76
77impl<T> PartialEq for ReactorProviderState<T>
78where
79    T: Reactor,
80{
81    fn eq(&self, rhs: &Self) -> bool {
82        self.id == rhs.id
83    }
84}
85
86/// The Reactor Agent Provider.
87///
88/// This component provides its children access to a reactor agent.
89#[function_component]
90pub fn ReactorProvider<R, C = Bincode>(props: &WorkerProviderProps) -> Html
91where
92    R: 'static + Reactor,
93    <<R as Reactor>::Scope as ReactorScoped>::Input:
94        Serialize + for<'de> Deserialize<'de> + 'static,
95    <<R as Reactor>::Scope as ReactorScoped>::Output:
96        Serialize + for<'de> Deserialize<'de> + 'static,
97    C: Codec + 'static,
98{
99    let WorkerProviderProps {
100        children,
101        path,
102        lazy,
103        reach,
104    } = props.clone();
105
106    // Creates a spawning function so Codec is can be erased from contexts.
107    let spawn_bridge_fn: Rc<dyn Fn() -> ReactorBridge<R>> = {
108        let path = path.clone();
109        Rc::new(move || ReactorSpawner::<R>::new().encoding::<C>().spawn(&path))
110    };
111
112    let state = {
113        use_memo((path, lazy, reach), move |(_path, lazy, reach)| {
114            let state = ReactorProviderState::<R> {
115                id: get_next_id(),
116                spawn_bridge_fn,
117                reach: *reach,
118                held_bridge: Rc::default(),
119            };
120
121            if *reach == Reach::Public && !*lazy {
122                state.get_held_bridge();
123            }
124            state
125        })
126    };
127
128    html! {
129        <ContextProvider<ReactorProviderState<R>> context={(*state).clone()}>
130            {children}
131        </ContextProvider<ReactorProviderState<R>>>
132    }
133}