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

yew_agent/oneshot/
provider.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
use core::fmt;
use std::any::type_name;
use std::cell::RefCell;
use std::rc::Rc;

use serde::{Deserialize, Serialize};
use yew::prelude::*;

use super::{Oneshot, OneshotBridge, OneshotSpawner};
use crate::utils::get_next_id;
use crate::worker::WorkerProviderProps;
use crate::{Bincode, Codec, Reach};

pub(crate) struct OneshotProviderState<T>
where
    T: Oneshot + 'static,
{
    id: usize,
    spawn_bridge_fn: Rc<dyn Fn() -> OneshotBridge<T>>,
    reach: Reach,
    held_bridge: Rc<RefCell<Option<OneshotBridge<T>>>>,
}

impl<T> fmt::Debug for OneshotProviderState<T>
where
    T: Oneshot,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(type_name::<Self>())
    }
}

impl<T> OneshotProviderState<T>
where
    T: Oneshot,
{
    fn get_held_bridge(&self) -> OneshotBridge<T> {
        let mut held_bridge = self.held_bridge.borrow_mut();

        match held_bridge.as_mut() {
            Some(m) => m.fork(),
            None => {
                let bridge = (self.spawn_bridge_fn)();
                *held_bridge = Some(bridge.fork());
                bridge
            }
        }
    }

    /// Creates a bridge, uses "fork" for public agents.
    pub fn create_bridge(&self) -> OneshotBridge<T> {
        match self.reach {
            Reach::Public => {
                let held_bridge = self.get_held_bridge();
                held_bridge.fork()
            }
            Reach::Private => (self.spawn_bridge_fn)(),
        }
    }
}

impl<T> Clone for OneshotProviderState<T>
where
    T: Oneshot,
{
    fn clone(&self) -> Self {
        Self {
            id: self.id,
            spawn_bridge_fn: self.spawn_bridge_fn.clone(),
            reach: self.reach,
            held_bridge: self.held_bridge.clone(),
        }
    }
}

impl<T> PartialEq for OneshotProviderState<T>
where
    T: Oneshot,
{
    fn eq(&self, rhs: &Self) -> bool {
        self.id == rhs.id
    }
}

/// The Oneshot Agent Provider.
///
/// This component provides its children access to an oneshot agent.
#[function_component]
pub fn OneshotProvider<T, C = Bincode>(props: &WorkerProviderProps) -> Html
where
    T: Oneshot + 'static,
    T::Input: Serialize + for<'de> Deserialize<'de> + 'static,
    T::Output: Serialize + for<'de> Deserialize<'de> + 'static,
    C: Codec + 'static,
{
    let WorkerProviderProps {
        children,
        path,
        lazy,
        reach,
    } = props.clone();

    // Creates a spawning function so Codec is can be erased from contexts.
    let spawn_bridge_fn: Rc<dyn Fn() -> OneshotBridge<T>> = {
        let path = path.clone();
        Rc::new(move || OneshotSpawner::<T>::new().encoding::<C>().spawn(&path))
    };

    let state = {
        use_memo((path, lazy, reach), move |(_path, lazy, reach)| {
            let state = OneshotProviderState::<T> {
                id: get_next_id(),
                spawn_bridge_fn,
                reach: *reach,
                held_bridge: Rc::default(),
            };

            if *reach == Reach::Public && !*lazy {
                state.get_held_bridge();
            }
            state
        })
    };

    html! {
        <ContextProvider<OneshotProviderState<T>> context={(*state).clone()}>
            {children}
        </ContextProvider<OneshotProviderState<T>>>
    }
}