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

yew_agent/oneshot/
spawner.rs

1use serde::de::Deserialize;
2use serde::ser::Serialize;
3
4use super::bridge::OneshotBridge;
5use super::traits::Oneshot;
6use super::worker::OneshotWorker;
7use crate::codec::{Bincode, Codec};
8use crate::worker::WorkerSpawner;
9
10/// A spawner to create oneshot workers.
11#[derive(Debug, Default)]
12pub struct OneshotSpawner<N, CODEC = Bincode>
13where
14    N: Oneshot + 'static,
15    CODEC: Codec,
16{
17    inner: WorkerSpawner<OneshotWorker<N>, CODEC>,
18}
19
20impl<N, CODEC> OneshotSpawner<N, CODEC>
21where
22    N: Oneshot + 'static,
23    CODEC: Codec,
24{
25    /// Creates a [OneshotSpawner].
26    pub const fn new() -> Self {
27        Self {
28            inner: WorkerSpawner::<OneshotWorker<N>, CODEC>::new(),
29        }
30    }
31
32    /// Sets a new message encoding.
33    pub const fn encoding<C>(&self) -> OneshotSpawner<N, C>
34    where
35        C: Codec,
36    {
37        OneshotSpawner {
38            inner: WorkerSpawner::<OneshotWorker<N>, C>::new(),
39        }
40    }
41
42    /// Indicates that [`spawn`](WorkerSpawner#method.spawn) should expect a
43    /// `path` to a loader shim script (e.g. when using Trunk, created by using
44    /// the [`data-loader-shim`](https://trunkrs.dev/assets/#link-asset-types)
45    /// asset type) and one does not need to be generated. `false` by default.
46    pub fn with_loader(mut self, with_loader: bool) -> Self {
47        self.inner.with_loader(with_loader);
48        self
49    }
50
51    /// Determines whether the worker will be spawned with
52    /// [`options.type`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#type)
53    /// set to `module`. `true` by default.
54    ///
55    /// This option should be un-set if the worker was created with the
56    /// `--target no-modules` flag of `wasm-bindgen`. If using Trunk, see the
57    /// [`data-bindgen-target`](https://trunkrs.dev/assets/#link-asset-types)
58    /// asset type.
59    pub fn as_module(mut self, as_module: bool) -> Self {
60        self.inner.as_module(as_module);
61
62        self
63    }
64
65    /// Spawns a Oneshot Worker.
66    pub fn spawn(mut self, path: &str) -> OneshotBridge<N>
67    where
68        N::Input: Serialize + for<'de> Deserialize<'de>,
69        N::Output: Serialize + for<'de> Deserialize<'de>,
70    {
71        let rx = OneshotBridge::register_callback(&mut self.inner);
72
73        let inner = self.inner.spawn(path);
74
75        OneshotBridge::new(inner, rx)
76    }
77}