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
/// `ReadOnlySignal<T>` represents a reactive value that can be updated from the server
/// and reflected in the client-side UI.
///
/// # Type Parameters
///
/// * `T`: The type of value stored in the signal. This type must satisfy the following trait bounds:
/// - `serde::Serialize`: For serialization when sending updates across the network.
/// - `serde::Deserialize<'static>`: For deserialization when receiving updates.
/// - `Clone`: To allow the value to be cloned when necessary.
/// - `Send`: To ensure the value can be safely transferred across thread boundaries.
/// - `Sync`: To allow the value to be safely shared between threads.
/// # Usage
///
/// On the server:
/// ```rust,ignore
/// #[cfg(feature = "ssr")]
/// fn create_server_signal() -> ReadOnlySignal<i32> {
/// ReadOnlySignal::new("counter", 0).unwrap()
/// }
/// ```
/// On the server, while outside of a leptos server function context, eg in an Actix or Axum
/// handler:
/// ```rust
/// #[cfg(feature = "ssr")]
/// use leptos_ws::ReadOnlySignal;
/// fn create_server_signal() -> ReadOnlySignal<i32> {
/// # fn get_signals_from_actix_or_axum() -> leptos_ws::WsSignals { leptos_ws::WsSignals::new() }
/// let mut signals = get_signals_from_actix_or_axum(); // get it from app state
/// ReadOnlySignal::new_with_context(&mut signals, "counter", 0).unwrap()
/// }
/// ```
///
/// On the client:
/// ```rust,ignore
/// #[cfg(any(feature = "csr", feature = "hydrate"))]
/// fn use_server_signal() {
/// let counter = ReadOnlySignal::<i32>::new("counter", 0);
/// // Use `counter.get()` to read the current value
/// }
/// ```
///
/// # Note
///
/// When using `ReadOnlySignal`, ensure that you've set up the WebSocket connection
/// using the `provide_websocket` function in your application's root component.
pub type ReadOnlySignal<T> = ServerReadOnlySignal;
pub type ReadOnlySignal<T> = ClientReadOnlySignal;