mirror of
https://github.com/leptos-rs/leptos.git
synced 2025-12-28 09:02:37 -05:00
Compare commits
21 Commits
2086
...
cleanup-te
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9c4a6ba9ba | ||
|
|
d63c2fd507 | ||
|
|
a4ea491dc0 | ||
|
|
3c89b9c930 | ||
|
|
93d7ba0d5f | ||
|
|
e188993800 | ||
|
|
c1dc8c7629 | ||
|
|
ab9de1b8c0 | ||
|
|
b39985d9b8 | ||
|
|
5e8e93001d | ||
|
|
a4ed0cbe5b | ||
|
|
422fe9f43b | ||
|
|
36df36e16c | ||
|
|
95fc79034b | ||
|
|
7403e4084f | ||
|
|
8feee5e5d7 | ||
|
|
e6da266b4f | ||
|
|
dcc7865989 | ||
|
|
c47893ad60 | ||
|
|
4c3bcaa68d | ||
|
|
fe060617d2 |
@@ -40,6 +40,8 @@ pin-project-lite = "0.2.14"
|
||||
dashmap = { version = "6.0", optional = true }
|
||||
once_cell = { version = "1.19", optional = true }
|
||||
async-broadcast = { version = "0.7.1", optional = true }
|
||||
bytecheck = "0.8.0"
|
||||
rkyv = { version = "0.8.8" }
|
||||
|
||||
[features]
|
||||
hydrate = ["leptos/hydrate"]
|
||||
|
||||
@@ -417,7 +417,6 @@ pub fn FileUploadWithProgress() -> impl IntoView {
|
||||
/// This requires us to store some global state of all the uploads. In a real app, you probably
|
||||
/// shouldn't do exactly what I'm doing here in the demo. For example, this map just
|
||||
/// distinguishes between files by filename, not by user.
|
||||
|
||||
#[cfg(feature = "ssr")]
|
||||
mod progress {
|
||||
use async_broadcast::{broadcast, Receiver, Sender};
|
||||
|
||||
@@ -4,6 +4,8 @@ use leptos::{config::get_configuration, logging};
|
||||
use leptos_axum::{generate_route_list, LeptosRoutes};
|
||||
use server_fns_axum::*;
|
||||
|
||||
// cargo make cli: error: unneeded `return` statement
|
||||
#[allow(clippy::needless_return)]
|
||||
#[tokio::main]
|
||||
async fn main() {
|
||||
simple_logger::init_with_level(log::Level::Error)
|
||||
|
||||
58
flake.lock
generated
58
flake.lock
generated
@@ -5,29 +5,11 @@
|
||||
"systems": "systems"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1701680307,
|
||||
"narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=",
|
||||
"lastModified": 1726560853,
|
||||
"narHash": "sha256-X6rJYSESBVr3hBoH0WbKE5KvhPU5bloyZ2L4K60/fPQ=",
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"rev": "4022d587cbbfd70fe950c1e2083a02621806a725",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"flake-utils_2": {
|
||||
"inputs": {
|
||||
"systems": "systems_2"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1681202837,
|
||||
"narHash": "sha256-H+Rh19JDwRtpVPAWp64F+rlEtxUWBAQW28eAi3SRSzg=",
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"rev": "cfacdce06f30d2b68473a46042957675eebb3401",
|
||||
"rev": "c1dfcf08411b08f6b8615f7d8971a2bfa81d5e8a",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -38,11 +20,11 @@
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1703961334,
|
||||
"narHash": "sha256-M1mV/Cq+pgjk0rt6VxoyyD+O8cOUiai8t9Q6Yyq4noY=",
|
||||
"lastModified": 1727634051,
|
||||
"narHash": "sha256-S5kVU7U82LfpEukbn/ihcyNt2+EvG7Z5unsKW9H/yFA=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "b0d36bd0a420ecee3bc916c91886caca87c894e9",
|
||||
"rev": "06cf0e1da4208d3766d898b7fdab6513366d45b9",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -54,11 +36,11 @@
|
||||
},
|
||||
"nixpkgs_2": {
|
||||
"locked": {
|
||||
"lastModified": 1681358109,
|
||||
"narHash": "sha256-eKyxW4OohHQx9Urxi7TQlFBTDWII+F+x2hklDOQPB50=",
|
||||
"lastModified": 1718428119,
|
||||
"narHash": "sha256-WdWDpNaq6u1IPtxtYHHWpl5BmabtpmLnMAx0RdJ/vo8=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "96ba1c52e54e74c3197f4d43026b3f3d92e83ff9",
|
||||
"rev": "e6cea36f83499eb4e9cd184c8a8e823296b50ad5",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -77,15 +59,14 @@
|
||||
},
|
||||
"rust-overlay": {
|
||||
"inputs": {
|
||||
"flake-utils": "flake-utils_2",
|
||||
"nixpkgs": "nixpkgs_2"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1704075545,
|
||||
"narHash": "sha256-L3zgOuVKhPjKsVLc3yTm2YJ6+BATyZBury7wnhyc8QU=",
|
||||
"lastModified": 1727749966,
|
||||
"narHash": "sha256-DUS8ehzqB1DQzfZ4bRXVSollJhu+y7cvh1DJ9mbWebE=",
|
||||
"owner": "oxalica",
|
||||
"repo": "rust-overlay",
|
||||
"rev": "a0df72e106322b67e9c6e591fe870380bd0da0d5",
|
||||
"rev": "00decf1b4f9886d25030b9ee4aed7bfddccb5f66",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -108,21 +89,6 @@
|
||||
"repo": "default",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"systems_2": {
|
||||
"locked": {
|
||||
"lastModified": 1681028828,
|
||||
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
|
||||
"owner": "nix-systems",
|
||||
"repo": "default",
|
||||
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "nix-systems",
|
||||
"repo": "default",
|
||||
"type": "github"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
|
||||
@@ -28,7 +28,7 @@ once_cell = "1"
|
||||
parking_lot = "0.12.3"
|
||||
serde_json = "1.0"
|
||||
tokio = { version = "1.39", default-features = false }
|
||||
tower = "0.4.13"
|
||||
tower = { version = "0.4.13", features = ["util"] }
|
||||
tower-http = "0.5.2"
|
||||
tracing = { version = "0.1.40", optional = true }
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ use server_fn::{redirect::REDIRECT_HEADER, ServerFnError};
|
||||
use std::path::Path;
|
||||
use std::{fmt::Debug, io, pin::Pin, sync::Arc};
|
||||
#[cfg(feature = "default")]
|
||||
use tower::ServiceExt;
|
||||
use tower::util::ServiceExt;
|
||||
#[cfg(feature = "default")]
|
||||
use tower_http::services::ServeDir;
|
||||
// use tracing::Instrument; // TODO check tracing span -- was this used in 0.6 for a missing link?
|
||||
|
||||
@@ -1,10 +1,8 @@
|
||||
use crate::Suspense;
|
||||
use leptos_dom::IntoView;
|
||||
use crate::{prelude::Suspend, suspense_component::Suspense, IntoView};
|
||||
use leptos_macro::{component, view};
|
||||
use leptos_reactive::{
|
||||
create_blocking_resource, create_local_resource, create_resource,
|
||||
store_value, Serializable,
|
||||
};
|
||||
use leptos_server::ArcOnceResource;
|
||||
use reactive_graph::prelude::ReadUntracked;
|
||||
use serde::{de::DeserializeOwned, Serialize};
|
||||
|
||||
#[component]
|
||||
/// Allows you to inline the data loading for an `async` block or
|
||||
@@ -15,11 +13,8 @@ use leptos_reactive::{
|
||||
/// Adding `let:{variable name}` to the props makes the data available in the children
|
||||
/// that variable name, when resolved.
|
||||
/// ```
|
||||
/// # use leptos_reactive::*;
|
||||
/// # use leptos_macro::*;
|
||||
/// # use leptos_dom::*; use leptos::*;
|
||||
/// # use leptos::prelude::*;
|
||||
/// # if false {
|
||||
/// # let runtime = create_runtime();
|
||||
/// async fn fetch_monkeys(monkey: i32) -> i32 {
|
||||
/// // do some expensive work
|
||||
/// 3
|
||||
@@ -27,29 +22,23 @@ use leptos_reactive::{
|
||||
///
|
||||
/// view! {
|
||||
/// <Await
|
||||
/// future=|| fetch_monkeys(3)
|
||||
/// future=fetch_monkeys(3)
|
||||
/// let:data
|
||||
/// >
|
||||
/// <p>{*data} " little monkeys, jumping on the bed."</p>
|
||||
/// </Await>
|
||||
/// }
|
||||
/// # ;
|
||||
/// # runtime.dispose();
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn Await<T, Fut, FF, VF, V>(
|
||||
/// A function that returns the [`Future`](std::future::Future) that
|
||||
/// will the component will `.await` before rendering.
|
||||
future: FF,
|
||||
/// If `true`, the component will use [`create_blocking_resource`], preventing
|
||||
pub fn Await<T, Fut, Chil, V>(
|
||||
/// A [`Future`](std::future::Future) that will the component will `.await`
|
||||
/// before rendering.
|
||||
future: Fut,
|
||||
/// If `true`, the component will create a blocking resource, preventing
|
||||
/// the HTML stream from returning anything before `future` has resolved.
|
||||
#[prop(optional)]
|
||||
blocking: bool,
|
||||
/// If `true`, the component will use [`create_local_resource`], this will
|
||||
/// always run on the local system and therefore its result type does not
|
||||
/// need to be `Serializable`.
|
||||
#[prop(optional)]
|
||||
local: bool,
|
||||
/// A function that takes a reference to the resolved data from the `future`
|
||||
/// renders a view.
|
||||
///
|
||||
@@ -58,65 +47,58 @@ pub fn Await<T, Fut, FF, VF, V>(
|
||||
/// `let:` syntax to specify the name for the data variable.
|
||||
///
|
||||
/// ```rust
|
||||
/// # use leptos::*;
|
||||
/// # use leptos::prelude::*;
|
||||
/// # if false {
|
||||
/// # let runtime = create_runtime();
|
||||
/// # async fn fetch_monkeys(monkey: i32) -> i32 {
|
||||
/// # 3
|
||||
/// # }
|
||||
/// view! {
|
||||
/// <Await
|
||||
/// future=|| fetch_monkeys(3)
|
||||
/// future=fetch_monkeys(3)
|
||||
/// let:data
|
||||
/// >
|
||||
/// <p>{*data} " little monkeys, jumping on the bed."</p>
|
||||
/// </Await>
|
||||
/// }
|
||||
/// # ;
|
||||
/// # runtime.dispose();
|
||||
/// # }
|
||||
/// ```
|
||||
/// is the same as
|
||||
/// ```rust
|
||||
/// # use leptos::*;
|
||||
/// # use leptos::prelude::*;
|
||||
/// # if false {
|
||||
/// # let runtime = create_runtime();
|
||||
/// # async fn fetch_monkeys(monkey: i32) -> i32 {
|
||||
/// # 3
|
||||
/// # }
|
||||
/// view! {
|
||||
/// <Await
|
||||
/// future=|| fetch_monkeys(3)
|
||||
/// future=fetch_monkeys(3)
|
||||
/// children=|data| view! {
|
||||
/// <p>{*data} " little monkeys, jumping on the bed."</p>
|
||||
/// }
|
||||
/// />
|
||||
/// }
|
||||
/// # ;
|
||||
/// # runtime.dispose();
|
||||
/// # }
|
||||
/// ```
|
||||
children: VF,
|
||||
children: Chil,
|
||||
) -> impl IntoView
|
||||
where
|
||||
Fut: std::future::Future<Output = T> + 'static,
|
||||
FF: Fn() -> Fut + 'static,
|
||||
T: Send + Sync + Serialize + DeserializeOwned + 'static,
|
||||
Fut: std::future::Future<Output = T> + Send + 'static,
|
||||
Chil: FnOnce(&T) -> V + Send + 'static,
|
||||
V: IntoView,
|
||||
VF: Fn(&T) -> V + 'static,
|
||||
T: Serializable + 'static,
|
||||
{
|
||||
let res = if blocking {
|
||||
create_blocking_resource(|| (), move |_| future())
|
||||
} else if local {
|
||||
create_local_resource(|| (), move |_| future())
|
||||
} else {
|
||||
create_resource(|| (), move |_| future())
|
||||
};
|
||||
let view = store_value(children);
|
||||
let res = ArcOnceResource::<T>::new_with_options(future, blocking);
|
||||
let ready = res.ready();
|
||||
|
||||
view! {
|
||||
<Suspense fallback=|| ()>
|
||||
{move || res.map(|data| view.with_value(|view| view(data)))}
|
||||
{Suspend::new(async move {
|
||||
ready.await;
|
||||
children(res.read_untracked().as_ref().unwrap())
|
||||
})}
|
||||
|
||||
</Suspense>
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,7 +41,10 @@
|
||||
//!
|
||||
//! Use `SyncCallback` if the function is not `Sync` and `Send`.
|
||||
|
||||
use reactive_graph::owner::{LocalStorage, StoredValue};
|
||||
use reactive_graph::{
|
||||
owner::{LocalStorage, StoredValue},
|
||||
traits::WithValue,
|
||||
};
|
||||
use std::{fmt, rc::Rc, sync::Arc};
|
||||
|
||||
/// A wrapper trait for calling callbacks.
|
||||
|
||||
@@ -200,10 +200,11 @@ pub mod error {
|
||||
pub use throw_error::*;
|
||||
}
|
||||
|
||||
/// Control-flow components like `<Show>` and `<For>`.
|
||||
/// Control-flow components like `<Show>`, `<For>`, and `<Await>`.
|
||||
pub mod control_flow {
|
||||
pub use crate::{for_loop::*, show::*};
|
||||
pub use crate::{await_::*, for_loop::*, show::*};
|
||||
}
|
||||
mod await_;
|
||||
mod for_loop;
|
||||
mod show;
|
||||
|
||||
@@ -328,7 +329,6 @@ pub use web_sys;
|
||||
|
||||
/*mod additional_attributes;
|
||||
pub use additional_attributes::*;
|
||||
mod await_;
|
||||
pub use await_::*;
|
||||
pub use leptos_config::{self, get_configuration, LeptosOptions};
|
||||
#[cfg(not(all(
|
||||
|
||||
@@ -326,9 +326,12 @@ fn inert_element_to_tokens(
|
||||
for attr in node.attributes() {
|
||||
if let NodeAttribute::Attribute(attr) = attr {
|
||||
let attr_name = attr.key.to_string();
|
||||
// trim r# from raw identifiers like r#as
|
||||
let attr_name =
|
||||
attr_name.trim_start_matches("r#");
|
||||
if attr_name != "class" {
|
||||
html.push(' ');
|
||||
html.push_str(&attr_name);
|
||||
html.push_str(attr_name);
|
||||
}
|
||||
|
||||
if let Some(value) =
|
||||
@@ -545,7 +548,9 @@ fn node_to_tokens(
|
||||
view_marker,
|
||||
disable_inert_html,
|
||||
),
|
||||
Node::Block(block) => Some(quote! { #block }),
|
||||
Node::Block(block) => {
|
||||
Some(quote! { ::leptos::prelude::IntoRender::into_render(#block) })
|
||||
}
|
||||
Node::Text(text) => Some(text_to_tokens(&text.value)),
|
||||
Node::RawText(raw) => {
|
||||
let text = raw.to_string_best();
|
||||
@@ -722,6 +727,11 @@ pub(crate) fn element_to_tokens(
|
||||
quote! { ::leptos::tachys::html::element::#custom(#name) }
|
||||
} else if is_svg_element(&tag) {
|
||||
parent_type = TagType::Svg;
|
||||
let name = if tag == "use" || tag == "use_" {
|
||||
Ident::new_raw("use", name.span()).to_token_stream()
|
||||
} else {
|
||||
name.to_token_stream()
|
||||
};
|
||||
quote! { ::leptos::tachys::svg::#name() }
|
||||
} else if is_math_ml_element(&tag) {
|
||||
parent_type = TagType::Math;
|
||||
@@ -875,7 +885,7 @@ fn attribute_to_tokens(
|
||||
NodeName::Path(path) => path.path.get_ident(),
|
||||
_ => unreachable!(),
|
||||
};
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, false);
|
||||
quote! {
|
||||
.#node_ref(#value)
|
||||
}
|
||||
@@ -925,13 +935,13 @@ fn attribute_to_tokens(
|
||||
// we don't provide statically-checked methods for SVG attributes
|
||||
|| (tag_type == TagType::Svg && name != "inner_html")
|
||||
{
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, true);
|
||||
quote! {
|
||||
.attr(#name, #value)
|
||||
}
|
||||
} else {
|
||||
let key = attribute_name(&node.key);
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, true);
|
||||
|
||||
// special case of global_class and class attribute
|
||||
if &node.key.to_string() == "class"
|
||||
@@ -968,11 +978,11 @@ pub(crate) fn attribute_absolute(
|
||||
let id = &parts[0];
|
||||
match id {
|
||||
NodeNameFragment::Ident(id) => {
|
||||
let value = attribute_value(node);
|
||||
// ignore `let:` and `clone:`
|
||||
if id == "let" || id == "clone" {
|
||||
None
|
||||
} else if id == "attr" {
|
||||
let value = attribute_value(node, true);
|
||||
let key = &parts[1];
|
||||
let key_name = key.to_string();
|
||||
if key_name == "class" || key_name == "style" {
|
||||
@@ -980,6 +990,7 @@ pub(crate) fn attribute_absolute(
|
||||
quote! { ::leptos::tachys::html::#key::#key(#value) },
|
||||
)
|
||||
} else if key_name == "aria" {
|
||||
let value = attribute_value(node, true);
|
||||
let mut parts_iter = parts.iter();
|
||||
parts_iter.next();
|
||||
let fn_name = parts_iter.map(|p| p.to_string()).collect::<Vec<String>>().join("_");
|
||||
@@ -1008,6 +1019,7 @@ pub(crate) fn attribute_absolute(
|
||||
},
|
||||
)
|
||||
} else if id == "style" || id == "class" {
|
||||
let value = attribute_value(node, false);
|
||||
let key = &node.key.to_string();
|
||||
let key = key
|
||||
.replacen("style:", "", 1)
|
||||
@@ -1016,6 +1028,7 @@ pub(crate) fn attribute_absolute(
|
||||
quote! { ::leptos::tachys::html::#id::#id((#key, #value)) },
|
||||
)
|
||||
} else if id == "prop" {
|
||||
let value = attribute_value(node, false);
|
||||
let key = &node.key.to_string();
|
||||
let key = key.replacen("prop:", "", 1);
|
||||
Some(
|
||||
@@ -1072,7 +1085,7 @@ pub(crate) fn two_way_binding_to_tokens(
|
||||
name: &str,
|
||||
node: &KeyedAttribute,
|
||||
) -> TokenStream {
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, false);
|
||||
|
||||
let ident =
|
||||
format_ident!("{}", name.to_case(UpperCamel), span = node.key.span());
|
||||
@@ -1097,7 +1110,7 @@ pub(crate) fn event_type_and_handler(
|
||||
name: &str,
|
||||
node: &KeyedAttribute,
|
||||
) -> (TokenStream, TokenStream, TokenStream) {
|
||||
let handler = attribute_value(node);
|
||||
let handler = attribute_value(node, false);
|
||||
|
||||
let (event_type, is_custom, is_force_undelegated, is_targeted) =
|
||||
parse_event_name(name);
|
||||
@@ -1154,7 +1167,7 @@ fn class_to_tokens(
|
||||
class: TokenStream,
|
||||
class_name: Option<&str>,
|
||||
) -> TokenStream {
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, false);
|
||||
if let Some(class_name) = class_name {
|
||||
quote! {
|
||||
.#class((#class_name, #value))
|
||||
@@ -1171,7 +1184,7 @@ fn style_to_tokens(
|
||||
style: TokenStream,
|
||||
style_name: Option<&str>,
|
||||
) -> TokenStream {
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, false);
|
||||
if let Some(style_name) = style_name {
|
||||
quote! {
|
||||
.#style((#style_name, #value))
|
||||
@@ -1188,7 +1201,7 @@ fn prop_to_tokens(
|
||||
prop: TokenStream,
|
||||
key: &str,
|
||||
) -> TokenStream {
|
||||
let value = attribute_value(node);
|
||||
let value = attribute_value(node, false);
|
||||
quote! {
|
||||
.#prop(#key, #value)
|
||||
}
|
||||
@@ -1345,7 +1358,10 @@ fn attribute_name(name: &NodeName) -> TokenStream {
|
||||
}
|
||||
}
|
||||
|
||||
fn attribute_value(attr: &KeyedAttribute) -> TokenStream {
|
||||
fn attribute_value(
|
||||
attr: &KeyedAttribute,
|
||||
is_attribute_proper: bool,
|
||||
) -> TokenStream {
|
||||
match attr.possible_value.to_value() {
|
||||
None => quote! { true },
|
||||
Some(value) => match &value.value {
|
||||
@@ -1360,14 +1376,26 @@ fn attribute_value(attr: &KeyedAttribute) -> TokenStream {
|
||||
}
|
||||
}
|
||||
|
||||
quote! {
|
||||
{#expr}
|
||||
if matches!(expr, Expr::Lit(_)) || !is_attribute_proper {
|
||||
quote! {
|
||||
#expr
|
||||
}
|
||||
} else {
|
||||
quote! {
|
||||
::leptos::prelude::IntoAttributeValue::into_attribute_value(#expr)
|
||||
}
|
||||
}
|
||||
}
|
||||
// any value in braces: expand as-is to give proper r-a support
|
||||
KVAttributeValue::InvalidBraced(block) => {
|
||||
quote! {
|
||||
#block
|
||||
if is_attribute_proper {
|
||||
quote! {
|
||||
::leptos::prelude::IntoAttributeValue::into_attribute_value(#block)
|
||||
}
|
||||
} else {
|
||||
quote! {
|
||||
#block
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
@@ -19,6 +19,7 @@ tracing = { version = "0.1.40", optional = true }
|
||||
futures = "0.3.30"
|
||||
|
||||
any_spawner = { workspace = true }
|
||||
or_poisoned = { workspace = true }
|
||||
tachys = { workspace = true, optional = true, features = ["reactive_graph"] }
|
||||
send_wrapper = "0.6"
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ mod local_resource;
|
||||
pub use local_resource::*;
|
||||
mod multi_action;
|
||||
pub use multi_action::*;
|
||||
mod once_resource;
|
||||
pub use once_resource::*;
|
||||
mod resource;
|
||||
pub use resource::*;
|
||||
mod shared;
|
||||
|
||||
@@ -35,10 +35,10 @@ impl<T> Clone for ArcLocalResource<T> {
|
||||
|
||||
impl<T> ArcLocalResource<T> {
|
||||
#[track_caller]
|
||||
pub fn new<Fut>(fetcher: impl Fn() -> Fut + Send + Sync + 'static) -> Self
|
||||
pub fn new<Fut>(fetcher: impl Fn() -> Fut + 'static) -> Self
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Fut: Future<Output = T> + Send + 'static,
|
||||
T: 'static,
|
||||
Fut: Future<Output = T> + 'static,
|
||||
{
|
||||
let fetcher = move || {
|
||||
let fut = fetcher();
|
||||
@@ -60,7 +60,7 @@ impl<T> ArcLocalResource<T> {
|
||||
}
|
||||
};
|
||||
Self {
|
||||
data: ArcAsyncDerived::new(fetcher),
|
||||
data: ArcAsyncDerived::new_unsync(fetcher),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
}
|
||||
@@ -103,7 +103,7 @@ impl<T> DefinedAt for ArcLocalResource<T> {
|
||||
|
||||
impl<T> ReadUntracked for ArcLocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
type Value = ReadGuard<Option<T>, AsyncPlain<Option<T>>>;
|
||||
|
||||
@@ -201,7 +201,7 @@ impl<T> LocalResource<T> {
|
||||
pub fn new<Fut>(fetcher: impl Fn() -> Fut + 'static) -> Self
|
||||
where
|
||||
T: 'static,
|
||||
Fut: Future<Output = T> + Send + 'static,
|
||||
Fut: Future<Output = T> + 'static,
|
||||
{
|
||||
let fetcher = move || {
|
||||
let fut = fetcher();
|
||||
@@ -230,7 +230,7 @@ impl<T> LocalResource<T> {
|
||||
let fetcher = SendWrapper::new(fetcher);
|
||||
AsyncDerived::new(move || {
|
||||
let fut = fetcher();
|
||||
async move { SendWrapper::new(fut.await) }
|
||||
SendWrapper::new(async move { SendWrapper::new(fut.await) })
|
||||
})
|
||||
},
|
||||
#[cfg(debug_assertions)]
|
||||
@@ -280,7 +280,7 @@ impl<T> DefinedAt for LocalResource<T> {
|
||||
|
||||
impl<T> ReadUntracked for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
type Value =
|
||||
ReadGuard<Option<SendWrapper<T>>, AsyncPlain<Option<SendWrapper<T>>>>;
|
||||
@@ -307,7 +307,7 @@ impl<T: 'static> IsDisposed for LocalResource<T> {
|
||||
|
||||
impl<T: 'static> ToAnySource for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
fn to_any_source(&self) -> AnySource {
|
||||
self.data.to_any_source()
|
||||
@@ -316,7 +316,7 @@ where
|
||||
|
||||
impl<T: 'static> ToAnySubscriber for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
fn to_any_subscriber(&self) -> AnySubscriber {
|
||||
self.data.to_any_subscriber()
|
||||
@@ -325,7 +325,7 @@ where
|
||||
|
||||
impl<T> Source for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
fn add_subscriber(&self, subscriber: AnySubscriber) {
|
||||
self.data.add_subscriber(subscriber)
|
||||
@@ -342,7 +342,7 @@ where
|
||||
|
||||
impl<T> ReactiveNode for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
fn mark_dirty(&self) {
|
||||
self.data.mark_dirty();
|
||||
@@ -363,7 +363,7 @@ where
|
||||
|
||||
impl<T> Subscriber for LocalResource<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
fn add_source(&self, source: AnySource) {
|
||||
self.data.add_source(source);
|
||||
|
||||
700
leptos_server/src/once_resource.rs
Normal file
700
leptos_server/src/once_resource.rs
Normal file
@@ -0,0 +1,700 @@
|
||||
use crate::{
|
||||
initial_value, FromEncodedStr, IntoEncodedString,
|
||||
IS_SUPPRESSING_RESOURCE_LOAD,
|
||||
};
|
||||
#[cfg(feature = "rkyv")]
|
||||
use codee::binary::RkyvCodec;
|
||||
#[cfg(feature = "serde-wasm-bindgen")]
|
||||
use codee::string::JsonSerdeWasmCodec;
|
||||
#[cfg(feature = "miniserde")]
|
||||
use codee::string::MiniserdeCodec;
|
||||
#[cfg(feature = "serde-lite")]
|
||||
use codee::SerdeLite;
|
||||
use codee::{
|
||||
string::{FromToStringCodec, JsonSerdeCodec},
|
||||
Decoder, Encoder,
|
||||
};
|
||||
use core::{fmt::Debug, marker::PhantomData};
|
||||
use futures::Future;
|
||||
use or_poisoned::OrPoisoned;
|
||||
use reactive_graph::{
|
||||
computed::{
|
||||
suspense::SuspenseContext, AsyncDerivedReadyFuture, ScopedFuture,
|
||||
},
|
||||
diagnostics::{SpecialNonReactiveFuture, SpecialNonReactiveZone},
|
||||
graph::{AnySource, ToAnySource},
|
||||
owner::{use_context, ArenaItem, Owner},
|
||||
prelude::*,
|
||||
signal::{
|
||||
guards::{Plain, ReadGuard},
|
||||
ArcTrigger,
|
||||
},
|
||||
unwrap_signal,
|
||||
};
|
||||
use std::{
|
||||
future::IntoFuture,
|
||||
mem,
|
||||
panic::Location,
|
||||
pin::Pin,
|
||||
sync::{
|
||||
atomic::{AtomicBool, Ordering},
|
||||
Arc, RwLock,
|
||||
},
|
||||
task::{Context, Poll, Waker},
|
||||
};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct ArcOnceResource<T, Ser = JsonSerdeCodec> {
|
||||
trigger: ArcTrigger,
|
||||
value: Arc<RwLock<Option<T>>>,
|
||||
wakers: Arc<RwLock<Vec<Waker>>>,
|
||||
suspenses: Arc<RwLock<Vec<SuspenseContext>>>,
|
||||
loading: Arc<AtomicBool>,
|
||||
ser: PhantomData<fn() -> Ser>,
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: &'static Location<'static>,
|
||||
}
|
||||
|
||||
impl<T, Ser> Clone for ArcOnceResource<T, Ser> {
|
||||
fn clone(&self) -> Self {
|
||||
Self {
|
||||
trigger: self.trigger.clone(),
|
||||
value: self.value.clone(),
|
||||
wakers: self.wakers.clone(),
|
||||
suspenses: self.suspenses.clone(),
|
||||
loading: self.loading.clone(),
|
||||
ser: self.ser,
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: self.defined_at,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ArcOnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: Encoder<T> + Decoder<T>,
|
||||
<Ser as Encoder<T>>::Error: Debug,
|
||||
<Ser as Decoder<T>>::Error: Debug,
|
||||
<<Ser as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<Ser as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<Ser as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_with_options(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
#[allow(unused)] // this is used with `feature = "ssr"`
|
||||
blocking: bool,
|
||||
) -> Self {
|
||||
let shared_context = Owner::current_shared_context();
|
||||
let id = shared_context
|
||||
.as_ref()
|
||||
.map(|sc| sc.next_id())
|
||||
.unwrap_or_default();
|
||||
|
||||
let initial = initial_value::<T, Ser>(&id, shared_context.as_ref());
|
||||
let is_ready = initial.is_some();
|
||||
let value = Arc::new(RwLock::new(initial));
|
||||
let wakers = Arc::new(RwLock::new(Vec::<Waker>::new()));
|
||||
let suspenses = Arc::new(RwLock::new(Vec::<SuspenseContext>::new()));
|
||||
let loading = Arc::new(AtomicBool::new(!is_ready));
|
||||
let trigger = ArcTrigger::new();
|
||||
|
||||
let fut = ScopedFuture::new(fut);
|
||||
|
||||
if !is_ready && !IS_SUPPRESSING_RESOURCE_LOAD.load(Ordering::Relaxed) {
|
||||
let value = Arc::clone(&value);
|
||||
let wakers = Arc::clone(&wakers);
|
||||
let loading = Arc::clone(&loading);
|
||||
let trigger = trigger.clone();
|
||||
reactive_graph::spawn(async move {
|
||||
let loaded = fut.await;
|
||||
*value.write().or_poisoned() = Some(loaded);
|
||||
loading.store(false, Ordering::Relaxed);
|
||||
for waker in mem::take(&mut *wakers.write().or_poisoned()) {
|
||||
waker.wake();
|
||||
}
|
||||
trigger.notify();
|
||||
});
|
||||
}
|
||||
|
||||
let data = Self {
|
||||
trigger,
|
||||
value: value.clone(),
|
||||
loading,
|
||||
wakers,
|
||||
suspenses,
|
||||
ser: PhantomData,
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
};
|
||||
|
||||
#[cfg(feature = "ssr")]
|
||||
if let Some(shared_context) = shared_context {
|
||||
let value = Arc::clone(&value);
|
||||
let ready_fut = data.ready();
|
||||
|
||||
if blocking {
|
||||
shared_context.defer_stream(Box::pin(data.ready()));
|
||||
}
|
||||
|
||||
if shared_context.get_is_hydrating() {
|
||||
shared_context.write_async(
|
||||
id,
|
||||
Box::pin(async move {
|
||||
ready_fut.await;
|
||||
let value = value.read().or_poisoned();
|
||||
let value = value.as_ref().unwrap();
|
||||
Ser::encode(value).unwrap().into_encoded_string()
|
||||
}),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
data
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ArcOnceResource<T, Ser> {
|
||||
/// Returns a `Future` that is ready when this resource has next finished loading.
|
||||
pub fn ready(&self) -> AsyncDerivedReadyFuture {
|
||||
AsyncDerivedReadyFuture::new(
|
||||
self.to_any_source(),
|
||||
&self.loading,
|
||||
&self.wakers,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> DefinedAt for ArcOnceResource<T, Ser> {
|
||||
fn defined_at(&self) -> Option<&'static Location<'static>> {
|
||||
#[cfg(not(debug_assertions))]
|
||||
{
|
||||
None
|
||||
}
|
||||
#[cfg(debug_assertions)]
|
||||
{
|
||||
Some(self.defined_at)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> IsDisposed for ArcOnceResource<T, Ser> {
|
||||
#[inline(always)]
|
||||
fn is_disposed(&self) -> bool {
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ToAnySource for ArcOnceResource<T, Ser> {
|
||||
fn to_any_source(&self) -> AnySource {
|
||||
self.trigger.to_any_source()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> Track for ArcOnceResource<T, Ser> {
|
||||
fn track(&self) {
|
||||
self.trigger.track();
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ReadUntracked for ArcOnceResource<T, Ser>
|
||||
where
|
||||
T: 'static,
|
||||
{
|
||||
type Value = ReadGuard<Option<T>, Plain<Option<T>>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
if let Some(suspense_context) = use_context::<SuspenseContext>() {
|
||||
if self.value.read().or_poisoned().is_none() {
|
||||
let handle = suspense_context.task_id();
|
||||
let ready = SpecialNonReactiveFuture::new(self.ready());
|
||||
reactive_graph::spawn(async move {
|
||||
ready.await;
|
||||
drop(handle);
|
||||
});
|
||||
self.suspenses.write().or_poisoned().push(suspense_context);
|
||||
}
|
||||
}
|
||||
Plain::try_new(Arc::clone(&self.value)).map(ReadGuard::new)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> IntoFuture for ArcOnceResource<T, Ser>
|
||||
where
|
||||
T: Clone + 'static,
|
||||
{
|
||||
type Output = T;
|
||||
type IntoFuture = OnceResourceFuture<T>;
|
||||
|
||||
fn into_future(self) -> Self::IntoFuture {
|
||||
OnceResourceFuture {
|
||||
source: self.to_any_source(),
|
||||
value: Arc::clone(&self.value),
|
||||
loading: Arc::clone(&self.loading),
|
||||
wakers: Arc::clone(&self.wakers),
|
||||
suspenses: Arc::clone(&self.suspenses),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// A [`Future`] that is ready when an [`ArcAsyncDerived`] is finished loading or reloading,
|
||||
/// and contains its value. `.await`ing this clones the value `T`.
|
||||
pub struct OnceResourceFuture<T> {
|
||||
source: AnySource,
|
||||
value: Arc<RwLock<Option<T>>>,
|
||||
loading: Arc<AtomicBool>,
|
||||
wakers: Arc<RwLock<Vec<Waker>>>,
|
||||
suspenses: Arc<RwLock<Vec<SuspenseContext>>>,
|
||||
}
|
||||
|
||||
impl<T> Future for OnceResourceFuture<T>
|
||||
where
|
||||
T: Clone + 'static,
|
||||
{
|
||||
type Output = T;
|
||||
|
||||
#[track_caller]
|
||||
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
|
||||
#[cfg(debug_assertions)]
|
||||
let _guard = SpecialNonReactiveZone::enter();
|
||||
let waker = cx.waker();
|
||||
self.source.track();
|
||||
|
||||
if let Some(suspense_context) = use_context::<SuspenseContext>() {
|
||||
self.suspenses.write().or_poisoned().push(suspense_context);
|
||||
}
|
||||
|
||||
if self.loading.load(Ordering::Relaxed) {
|
||||
self.wakers.write().or_poisoned().push(waker.clone());
|
||||
Poll::Pending
|
||||
} else {
|
||||
Poll::Ready(
|
||||
self.value.read().or_poisoned().as_ref().unwrap().clone(),
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> ArcOnceResource<T, JsonSerdeCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
JsonSerdeCodec: Encoder<T> + Decoder<T>,
|
||||
<JsonSerdeCodec as Encoder<T>>::Error: Debug,
|
||||
<JsonSerdeCodec as Decoder<T>>::Error: Debug,
|
||||
<<JsonSerdeCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<JsonSerdeCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<JsonSerdeCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_blocking(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> ArcOnceResource<T, FromToStringCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
FromToStringCodec: Encoder<T> + Decoder<T>,
|
||||
<FromToStringCodec as Encoder<T>>::Error: Debug, <FromToStringCodec as Decoder<T>>::Error: Debug,
|
||||
<<FromToStringCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<FromToStringCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<FromToStringCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
pub fn new_str(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
pub fn new_str_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "serde-wasm-bindgen")]
|
||||
impl<T> ArcOnceResource<T, JsonSerdeWasmCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
JsonSerdeWasmCodec: Encoder<T> + Decoder<T>,
|
||||
<JsonSerdeWasmCodec as Encoder<T>>::Error: Debug, <JsonSerdeWasmCodec as Decoder<T>>::Error: Debug,
|
||||
<<JsonSerdeWasmCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<JsonSerdeWasmCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<JsonSerdeWasmCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_serde_wb(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_serde_wb_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
#[cfg(feature = "miniserde")]
|
||||
impl<T> ArcOnceResource<T, MiniserdeCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
MiniserdeCodec: Encoder<T> + Decoder<T>,
|
||||
<MiniserdeCodec as Encoder<T>>::Error: Debug,
|
||||
<MiniserdeCodec as Decoder<T>>::Error: Debug,
|
||||
<<MiniserdeCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<MiniserdeCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<MiniserdeCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_miniserde(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_miniserde_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "serde-lite")]
|
||||
impl<T> ArcOnceResource<T, SerdeLite<JsonSerdeCodec>>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
SerdeLite<JsonSerdeCodec>: Encoder<T> + Decoder<T>,
|
||||
<SerdeLite<JsonSerdeCodec> as Encoder<T>>::Error: Debug, <SerdeLite<JsonSerdeCodec> as Decoder<T>>::Error: Debug,
|
||||
<<SerdeLite<JsonSerdeCodec> as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<SerdeLite<JsonSerdeCodec> as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<SerdeLite<JsonSerdeCodec> as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_serde_lite(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_serde_lite_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rkyv")]
|
||||
impl<T> ArcOnceResource<T, RkyvCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
RkyvCodec: Encoder<T> + Decoder<T>,
|
||||
<RkyvCodec as Encoder<T>>::Error: Debug,
|
||||
<RkyvCodec as Decoder<T>>::Error: Debug,
|
||||
<<RkyvCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<RkyvCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<RkyvCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_rkyv(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_rkyv_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
ArcOnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct OnceResource<T, Ser = JsonSerdeCodec> {
|
||||
inner: ArenaItem<ArcOnceResource<T, Ser>>,
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: &'static Location<'static>,
|
||||
}
|
||||
|
||||
impl<T, Ser> OnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: Encoder<T> + Decoder<T>,
|
||||
<Ser as Encoder<T>>::Error: Debug,
|
||||
<Ser as Decoder<T>>::Error: Debug,
|
||||
<<Ser as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<Ser as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<Ser as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_with_options(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
blocking: bool,
|
||||
) -> Self {
|
||||
#[cfg(debug_assertions)]
|
||||
let defined_at = Location::caller();
|
||||
Self {
|
||||
inner: ArenaItem::new(ArcOnceResource::new_with_options(
|
||||
fut, blocking,
|
||||
)),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> OnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: 'static,
|
||||
{
|
||||
/// Returns a `Future` that is ready when this resource has next finished loading.
|
||||
pub fn ready(&self) -> AsyncDerivedReadyFuture {
|
||||
self.inner
|
||||
.try_with_value(|inner| inner.ready())
|
||||
.unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> DefinedAt for OnceResource<T, Ser> {
|
||||
fn defined_at(&self) -> Option<&'static Location<'static>> {
|
||||
#[cfg(not(debug_assertions))]
|
||||
{
|
||||
None
|
||||
}
|
||||
#[cfg(debug_assertions)]
|
||||
{
|
||||
Some(self.defined_at)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> IsDisposed for OnceResource<T, Ser> {
|
||||
#[inline(always)]
|
||||
fn is_disposed(&self) -> bool {
|
||||
false
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ToAnySource for OnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: 'static,
|
||||
{
|
||||
fn to_any_source(&self) -> AnySource {
|
||||
self.inner
|
||||
.try_with_value(|inner| inner.to_any_source())
|
||||
.unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> Track for OnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: 'static,
|
||||
{
|
||||
fn track(&self) {
|
||||
if let Some(inner) = self.inner.try_get_value() {
|
||||
inner.track();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> ReadUntracked for OnceResource<T, Ser>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
Ser: 'static,
|
||||
{
|
||||
type Value = ReadGuard<Option<T>, Plain<Option<T>>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
self.inner
|
||||
.try_with_value(|inner| inner.try_read_untracked())
|
||||
.flatten()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, Ser> IntoFuture for OnceResource<T, Ser>
|
||||
where
|
||||
T: Clone + Send + Sync + 'static,
|
||||
Ser: 'static,
|
||||
{
|
||||
type Output = T;
|
||||
type IntoFuture = OnceResourceFuture<T>;
|
||||
|
||||
fn into_future(self) -> Self::IntoFuture {
|
||||
self.inner
|
||||
.try_get_value()
|
||||
.unwrap_or_else(unwrap_signal!(self))
|
||||
.into_future()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> OnceResource<T, JsonSerdeCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
JsonSerdeCodec: Encoder<T> + Decoder<T>,
|
||||
<JsonSerdeCodec as Encoder<T>>::Error: Debug,
|
||||
<JsonSerdeCodec as Decoder<T>>::Error: Debug,
|
||||
<<JsonSerdeCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<JsonSerdeCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<JsonSerdeCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_blocking(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> OnceResource<T, FromToStringCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
FromToStringCodec: Encoder<T> + Decoder<T>,
|
||||
<FromToStringCodec as Encoder<T>>::Error: Debug, <FromToStringCodec as Decoder<T>>::Error: Debug,
|
||||
<<FromToStringCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<FromToStringCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<FromToStringCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
pub fn new_str(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
pub fn new_str_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "serde-wasm-bindgen")]
|
||||
impl<T> OnceResource<T, JsonSerdeWasmCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
JsonSerdeWasmCodec: Encoder<T> + Decoder<T>,
|
||||
<JsonSerdeWasmCodec as Encoder<T>>::Error: Debug, <JsonSerdeWasmCodec as Decoder<T>>::Error: Debug,
|
||||
<<JsonSerdeWasmCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<JsonSerdeWasmCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<JsonSerdeWasmCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_serde_wb(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_serde_wb_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
#[cfg(feature = "miniserde")]
|
||||
impl<T> OnceResource<T, MiniserdeCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
MiniserdeCodec: Encoder<T> + Decoder<T>,
|
||||
<MiniserdeCodec as Encoder<T>>::Error: Debug,
|
||||
<MiniserdeCodec as Decoder<T>>::Error: Debug,
|
||||
<<MiniserdeCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<MiniserdeCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<MiniserdeCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_miniserde(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_miniserde_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "serde-lite")]
|
||||
impl<T> OnceResource<T, SerdeLite<JsonSerdeCodec>>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
SerdeLite<JsonSerdeCodec>: Encoder<T> + Decoder<T>,
|
||||
<SerdeLite<JsonSerdeCodec> as Encoder<T>>::Error: Debug, <SerdeLite<JsonSerdeCodec> as Decoder<T>>::Error: Debug,
|
||||
<<SerdeLite<JsonSerdeCodec> as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<SerdeLite<JsonSerdeCodec> as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<SerdeLite<JsonSerdeCodec> as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_serde_lite(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_serde_lite_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static
|
||||
) -> Self
|
||||
{
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "rkyv")]
|
||||
impl<T> OnceResource<T, RkyvCodec>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
RkyvCodec: Encoder<T> + Decoder<T>,
|
||||
<RkyvCodec as Encoder<T>>::Error: Debug,
|
||||
<RkyvCodec as Decoder<T>>::Error: Debug,
|
||||
<<RkyvCodec as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError:
|
||||
Debug,
|
||||
<RkyvCodec as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<RkyvCodec as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[track_caller]
|
||||
pub fn new_rkyv(fut: impl Future<Output = T> + Send + 'static) -> Self {
|
||||
OnceResource::new_with_options(fut, false)
|
||||
}
|
||||
|
||||
#[track_caller]
|
||||
pub fn new_rkyv_blocking(
|
||||
fut: impl Future<Output = T> + Send + 'static,
|
||||
) -> Self {
|
||||
OnceResource::new_with_options(fut, true)
|
||||
}
|
||||
}
|
||||
@@ -13,7 +13,7 @@ use codee::{
|
||||
};
|
||||
use core::{fmt::Debug, marker::PhantomData};
|
||||
use futures::Future;
|
||||
use hydration_context::SerializedDataId;
|
||||
use hydration_context::{SerializedDataId, SharedContext};
|
||||
use reactive_graph::{
|
||||
computed::{
|
||||
ArcAsyncDerived, ArcMemo, AsyncDerived, AsyncDerivedFuture,
|
||||
@@ -28,10 +28,14 @@ use std::{
|
||||
future::{pending, IntoFuture},
|
||||
ops::Deref,
|
||||
panic::Location,
|
||||
sync::atomic::{AtomicBool, Ordering},
|
||||
sync::{
|
||||
atomic::{AtomicBool, Ordering},
|
||||
Arc,
|
||||
},
|
||||
};
|
||||
|
||||
static IS_SUPPRESSING_RESOURCE_LOAD: AtomicBool = AtomicBool::new(false);
|
||||
pub(crate) static IS_SUPPRESSING_RESOURCE_LOAD: AtomicBool =
|
||||
AtomicBool::new(false);
|
||||
|
||||
pub struct SuppressResourceLoad;
|
||||
|
||||
@@ -175,7 +179,7 @@ where
|
||||
.map(|sc| sc.next_id())
|
||||
.unwrap_or_default();
|
||||
|
||||
let initial = Self::initial_value(&id);
|
||||
let initial = initial_value::<T, Ser>(&id, shared_context.as_ref());
|
||||
let is_ready = initial.is_some();
|
||||
|
||||
let refetch = ArcRwSignal::new(0);
|
||||
@@ -253,43 +257,53 @@ where
|
||||
pub fn refetch(&self) {
|
||||
*self.refetch.write() += 1;
|
||||
}
|
||||
}
|
||||
|
||||
#[inline(always)]
|
||||
#[allow(unused)]
|
||||
fn initial_value(id: &SerializedDataId) -> Option<T> {
|
||||
#[cfg(feature = "hydration")]
|
||||
{
|
||||
use std::borrow::Borrow;
|
||||
#[inline(always)]
|
||||
#[allow(unused)]
|
||||
pub(crate) fn initial_value<T, Ser>(
|
||||
id: &SerializedDataId,
|
||||
shared_context: Option<&Arc<dyn SharedContext + Send + Sync>>,
|
||||
) -> Option<T>
|
||||
where
|
||||
Ser: Encoder<T> + Decoder<T>,
|
||||
<Ser as Encoder<T>>::Error: Debug,
|
||||
<Ser as Decoder<T>>::Error: Debug,
|
||||
<<Ser as Decoder<T>>::Encoded as FromEncodedStr>::DecodingError: Debug,
|
||||
<Ser as Encoder<T>>::Encoded: IntoEncodedString,
|
||||
<Ser as Decoder<T>>::Encoded: FromEncodedStr,
|
||||
{
|
||||
#[cfg(feature = "hydration")]
|
||||
{
|
||||
use std::borrow::Borrow;
|
||||
|
||||
let shared_context = Owner::current_shared_context();
|
||||
if let Some(shared_context) = shared_context {
|
||||
let value = shared_context.read_data(id);
|
||||
if let Some(value) = value {
|
||||
let encoded =
|
||||
match <Ser as Decoder<T>>::Encoded::from_encoded_str(
|
||||
&value,
|
||||
) {
|
||||
Ok(value) => value,
|
||||
Err(e) => {
|
||||
#[cfg(feature = "tracing")]
|
||||
tracing::error!("couldn't deserialize: {e:?}");
|
||||
return None;
|
||||
}
|
||||
};
|
||||
let encoded = encoded.borrow();
|
||||
match Ser::decode(encoded) {
|
||||
Ok(value) => return Some(value),
|
||||
#[allow(unused)]
|
||||
let shared_context = Owner::current_shared_context();
|
||||
if let Some(shared_context) = shared_context {
|
||||
let value = shared_context.read_data(id);
|
||||
if let Some(value) = value {
|
||||
let encoded =
|
||||
match <Ser as Decoder<T>>::Encoded::from_encoded_str(&value)
|
||||
{
|
||||
Ok(value) => value,
|
||||
Err(e) => {
|
||||
#[cfg(feature = "tracing")]
|
||||
tracing::error!("couldn't deserialize: {e:?}");
|
||||
return None;
|
||||
}
|
||||
};
|
||||
let encoded = encoded.borrow();
|
||||
match Ser::decode(encoded) {
|
||||
Ok(value) => return Some(value),
|
||||
#[allow(unused)]
|
||||
Err(e) => {
|
||||
#[cfg(feature = "tracing")]
|
||||
tracing::error!("couldn't deserialize: {e:?}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
None
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
impl<T, E, Ser> ArcResource<Result<T, E>, Ser>
|
||||
|
||||
@@ -15,6 +15,7 @@ use crate::{
|
||||
};
|
||||
pub use arc_memo::*;
|
||||
pub use async_derived::*;
|
||||
pub(crate) use inner::MemoInner;
|
||||
pub use memo::*;
|
||||
pub use selector::*;
|
||||
|
||||
|
||||
@@ -534,11 +534,11 @@ impl<T: 'static> ArcAsyncDerived<T> {
|
||||
|
||||
/// Returns a `Future` that is ready when this resource has next finished loading.
|
||||
pub fn ready(&self) -> AsyncDerivedReadyFuture {
|
||||
AsyncDerivedReadyFuture {
|
||||
source: self.to_any_source(),
|
||||
loading: Arc::clone(&self.loading),
|
||||
wakers: Arc::clone(&self.wakers),
|
||||
}
|
||||
AsyncDerivedReadyFuture::new(
|
||||
self.to_any_source(),
|
||||
&self.loading,
|
||||
&self.wakers,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -34,6 +34,21 @@ pub struct AsyncDerivedReadyFuture {
|
||||
pub(crate) wakers: Arc<RwLock<Vec<Waker>>>,
|
||||
}
|
||||
|
||||
impl AsyncDerivedReadyFuture {
|
||||
/// Creates a new [`Future`] that will be ready when the given resource is ready.
|
||||
pub fn new(
|
||||
source: AnySource,
|
||||
loading: &Arc<AtomicBool>,
|
||||
wakers: &Arc<RwLock<Vec<Waker>>>,
|
||||
) -> Self {
|
||||
AsyncDerivedReadyFuture {
|
||||
source,
|
||||
loading: Arc::clone(loading),
|
||||
wakers: Arc::clone(wakers),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Future for AsyncDerivedReadyFuture {
|
||||
type Output = ();
|
||||
|
||||
|
||||
@@ -53,7 +53,8 @@ impl Drop for SpecialNonReactiveZoneGuard {
|
||||
}
|
||||
|
||||
pin_project! {
|
||||
pub(crate) struct SpecialNonReactiveFuture<Fut> {
|
||||
#[doc(hidden)]
|
||||
pub struct SpecialNonReactiveFuture<Fut> {
|
||||
#[pin]
|
||||
inner: Fut
|
||||
}
|
||||
|
||||
@@ -125,7 +125,7 @@ pub fn log_warning(text: Arguments) {
|
||||
|
||||
/// Calls [`Executor::spawn`], but ensures that the task also runs in the current arena, if
|
||||
/// multithreaded arena sandboxing is enabled.
|
||||
pub(crate) fn spawn(task: impl Future<Output = ()> + Send + 'static) {
|
||||
pub fn spawn(task: impl Future<Output = ()> + Send + 'static) {
|
||||
#[cfg(feature = "sandboxed-arenas")]
|
||||
let task = owner::Sandboxed::new(task);
|
||||
|
||||
|
||||
@@ -12,12 +12,14 @@ use std::{
|
||||
sync::{Arc, RwLock, Weak},
|
||||
};
|
||||
|
||||
mod arc_stored_value;
|
||||
mod arena;
|
||||
mod arena_item;
|
||||
mod context;
|
||||
mod storage;
|
||||
mod stored_value;
|
||||
use self::arena::Arena;
|
||||
pub use arc_stored_value::ArcStoredValue;
|
||||
#[cfg(feature = "sandboxed-arenas")]
|
||||
pub use arena::sandboxed::Sandboxed;
|
||||
#[cfg(feature = "sandboxed-arenas")]
|
||||
|
||||
126
reactive_graph/src/owner/arc_stored_value.rs
Normal file
126
reactive_graph/src/owner/arc_stored_value.rs
Normal file
@@ -0,0 +1,126 @@
|
||||
use crate::{
|
||||
signal::guards::{Plain, ReadGuard, UntrackedWriteGuard},
|
||||
traits::{DefinedAt, IsDisposed, ReadValue, WriteValue},
|
||||
};
|
||||
use std::{
|
||||
fmt::{Debug, Formatter},
|
||||
hash::Hash,
|
||||
panic::Location,
|
||||
sync::{Arc, RwLock},
|
||||
};
|
||||
|
||||
/// A reference-counted getter for any value non-reactively.
|
||||
///
|
||||
/// This is a reference-counted value, which is `Clone` but not `Copy`.
|
||||
/// For arena-allocated `Copy` values, use [`StoredValue`](super::StoredValue).
|
||||
///
|
||||
/// This allows you to create a stable reference for any value by storing it within
|
||||
/// the reactive system. Unlike e.g. [`ArcRwSignal`](crate::signal::ArcRwSignal), it is not reactive;
|
||||
/// accessing it does not cause effects to subscribe, and
|
||||
/// updating it does not notify anything else.
|
||||
pub struct ArcStoredValue<T> {
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: &'static Location<'static>,
|
||||
value: Arc<RwLock<T>>,
|
||||
}
|
||||
|
||||
impl<T> Clone for ArcStoredValue<T> {
|
||||
fn clone(&self) -> Self {
|
||||
Self {
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: self.defined_at,
|
||||
value: Arc::clone(&self.value),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Debug for ArcStoredValue<T> {
|
||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
||||
f.debug_struct("ArcStoredValue")
|
||||
.field("type", &std::any::type_name::<T>())
|
||||
.field("value", &Arc::as_ptr(&self.value))
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Default> Default for ArcStoredValue<T> {
|
||||
#[track_caller]
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
value: Arc::new(RwLock::new(T::default())),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> PartialEq for ArcStoredValue<T> {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
Arc::ptr_eq(&self.value, &other.value)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Eq for ArcStoredValue<T> {}
|
||||
|
||||
impl<T> Hash for ArcStoredValue<T> {
|
||||
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
|
||||
std::ptr::hash(&Arc::as_ptr(&self.value), state);
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> DefinedAt for ArcStoredValue<T> {
|
||||
fn defined_at(&self) -> Option<&'static Location<'static>> {
|
||||
#[cfg(debug_assertions)]
|
||||
{
|
||||
Some(self.defined_at)
|
||||
}
|
||||
#[cfg(not(debug_assertions))]
|
||||
{
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> ArcStoredValue<T> {
|
||||
/// Creates a new stored value, taking the initial value as its argument.
|
||||
#[cfg_attr(
|
||||
feature = "tracing",
|
||||
tracing::instrument(level = "trace", skip_all)
|
||||
)]
|
||||
#[track_caller]
|
||||
pub fn new(value: T) -> Self {
|
||||
Self {
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
value: Arc::new(RwLock::new(value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> ReadValue for ArcStoredValue<T>
|
||||
where
|
||||
T: 'static,
|
||||
{
|
||||
type Value = ReadGuard<T, Plain<T>>;
|
||||
|
||||
fn try_read_value(&self) -> Option<ReadGuard<T, Plain<T>>> {
|
||||
Plain::try_new(Arc::clone(&self.value)).map(ReadGuard::new)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> WriteValue for ArcStoredValue<T>
|
||||
where
|
||||
T: 'static,
|
||||
{
|
||||
type Value = T;
|
||||
|
||||
fn try_write_value(&self) -> Option<UntrackedWriteGuard<T>> {
|
||||
UntrackedWriteGuard::try_new(self.value.clone())
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> IsDisposed for ArcStoredValue<T> {
|
||||
fn is_disposed(&self) -> bool {
|
||||
false
|
||||
}
|
||||
}
|
||||
@@ -1,14 +1,16 @@
|
||||
use super::{ArenaItem, LocalStorage, Storage, SyncStorage};
|
||||
use super::{
|
||||
arc_stored_value::ArcStoredValue, ArenaItem, LocalStorage, Storage,
|
||||
SyncStorage,
|
||||
};
|
||||
use crate::{
|
||||
signal::guards::{Plain, ReadGuard, UntrackedWriteGuard},
|
||||
traits::{DefinedAt, Dispose, IsDisposed},
|
||||
traits::{DefinedAt, Dispose, IsDisposed, ReadValue, WriteValue},
|
||||
unwrap_signal,
|
||||
};
|
||||
use or_poisoned::OrPoisoned;
|
||||
use std::{
|
||||
fmt::{Debug, Formatter},
|
||||
hash::Hash,
|
||||
panic::Location,
|
||||
sync::{Arc, RwLock},
|
||||
};
|
||||
|
||||
/// A **non-reactive**, `Copy` handle for any value.
|
||||
@@ -18,9 +20,8 @@ use std::{
|
||||
/// and [`RwSignal`](crate::signal::RwSignal)), it is `Copy` and `'static`. Unlike the signal
|
||||
/// types, it is not reactive; accessing it does not cause effects to subscribe, and
|
||||
/// updating it does not notify anything else.
|
||||
#[derive(Debug)]
|
||||
pub struct StoredValue<T, S = SyncStorage> {
|
||||
value: ArenaItem<Arc<RwLock<T>>, S>,
|
||||
value: ArenaItem<ArcStoredValue<T>, S>,
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: &'static Location<'static>,
|
||||
}
|
||||
@@ -33,6 +34,18 @@ impl<T, S> Clone for StoredValue<T, S> {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Debug for StoredValue<T, S>
|
||||
where
|
||||
S: Debug,
|
||||
{
|
||||
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
||||
f.debug_struct("StoredValue")
|
||||
.field("type", &std::any::type_name::<T>())
|
||||
.field("value", &self.value)
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> PartialEq for StoredValue<T, S> {
|
||||
fn eq(&self, other: &Self) -> bool {
|
||||
self.value == other.value
|
||||
@@ -63,13 +76,13 @@ impl<T, S> DefinedAt for StoredValue<T, S> {
|
||||
impl<T, S> StoredValue<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<Arc<RwLock<T>>>,
|
||||
S: Storage<ArcStoredValue<T>>,
|
||||
{
|
||||
/// Stores the given value in the arena allocator.
|
||||
#[track_caller]
|
||||
pub fn new_with_storage(value: T) -> Self {
|
||||
Self {
|
||||
value: ArenaItem::new_with_storage(Arc::new(RwLock::new(value))),
|
||||
value: ArenaItem::new_with_storage(ArcStoredValue::new(value)),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
}
|
||||
@@ -79,7 +92,7 @@ where
|
||||
impl<T, S> Default for StoredValue<T, S>
|
||||
where
|
||||
T: Default + 'static,
|
||||
S: Storage<Arc<RwLock<T>>>,
|
||||
S: Storage<ArcStoredValue<T>>,
|
||||
{
|
||||
#[track_caller] // Default trait is not annotated with #[track_caller]
|
||||
fn default() -> Self {
|
||||
@@ -109,268 +122,31 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S: Storage<Arc<RwLock<T>>>> StoredValue<T, S> {
|
||||
/// Returns an [`Option`] of applying a function to the value within the [`StoredValue`].
|
||||
///
|
||||
/// If the owner of the reactive node has not been disposed [`Some`] is returned. Calling this
|
||||
/// function after the owner has been disposed will always return [`None`].
|
||||
///
|
||||
/// See [`StoredValue::with_value`] for a version that panics in the case of the owner being
|
||||
/// disposed.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
/// # use reactive_graph::traits::Dispose;
|
||||
///
|
||||
/// // Does not implement Clone
|
||||
/// struct Data {
|
||||
/// rows: Vec<u8>,
|
||||
/// }
|
||||
///
|
||||
/// let data = StoredValue::new(Data {
|
||||
/// rows: vec![0, 1, 2, 3, 4],
|
||||
/// });
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static.
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let length_fn = move || data.try_with_value(|inner| inner.rows.len());
|
||||
///
|
||||
/// let sum = data.try_with_value(|inner| inner.rows.iter().sum::<u8>());
|
||||
///
|
||||
/// assert_eq!(sum, Some(10));
|
||||
/// assert_eq!(length_fn(), Some(5));
|
||||
///
|
||||
/// // You should not call dispose yourself in normal user code.
|
||||
/// // This is shown here for the sake of the example.
|
||||
/// data.dispose();
|
||||
///
|
||||
/// let last = data.try_with_value(|inner| inner.rows.last().cloned());
|
||||
///
|
||||
/// assert_eq!(last, None);
|
||||
/// assert_eq!(length_fn(), None);
|
||||
/// ```
|
||||
#[track_caller]
|
||||
pub fn try_with_value<U>(&self, fun: impl FnOnce(&T) -> U) -> Option<U> {
|
||||
impl<T, S> ReadValue for StoredValue<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<ArcStoredValue<T>>,
|
||||
{
|
||||
type Value = ReadGuard<T, Plain<T>>;
|
||||
|
||||
fn try_read_value(&self) -> Option<ReadGuard<T, Plain<T>>> {
|
||||
self.value
|
||||
.try_get_value()
|
||||
.map(|inner| fun(&*inner.read().or_poisoned()))
|
||||
.and_then(|inner| inner.try_read_value())
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns the output of applying a function to the value within the [`StoredValue`].
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_with_value`] for a version without panic.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
///
|
||||
/// // Does not implement Clone
|
||||
/// struct Data {
|
||||
/// rows: Vec<u8>,
|
||||
/// }
|
||||
///
|
||||
/// let data = StoredValue::new(Data {
|
||||
/// rows: vec![1, 2, 3],
|
||||
/// });
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static.
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let length_fn = move || data.with_value(|inner| inner.rows.len());
|
||||
///
|
||||
/// let sum = data.with_value(|inner| inner.rows.iter().sum::<u8>());
|
||||
///
|
||||
/// assert_eq!(sum, 6);
|
||||
/// assert_eq!(length_fn(), 3);
|
||||
/// ```
|
||||
#[track_caller]
|
||||
pub fn with_value<U>(&self, fun: impl FnOnce(&T) -> U) -> U {
|
||||
self.try_with_value(fun)
|
||||
.unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
impl<T, S> WriteValue for StoredValue<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<ArcStoredValue<T>>,
|
||||
{
|
||||
type Value = T;
|
||||
|
||||
/// Returns a read guard to the stored data, or `None` if the owner of the reactive node has been disposed.
|
||||
#[track_caller]
|
||||
pub fn try_read_value(&self) -> Option<ReadGuard<T, Plain<T>>> {
|
||||
fn try_write_value(&self) -> Option<UntrackedWriteGuard<T>> {
|
||||
self.value
|
||||
.try_get_value()
|
||||
.and_then(|inner| Plain::try_new(inner).map(ReadGuard::new))
|
||||
}
|
||||
|
||||
/// Returns a read guard to the stored data.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_read_value`] for a version without panic.
|
||||
#[track_caller]
|
||||
pub fn read_value(&self) -> ReadGuard<T, Plain<T>> {
|
||||
self.try_read_value().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
|
||||
/// Returns a write guard to the stored data, or `None` if the owner of the reactive node has been disposed.
|
||||
#[track_caller]
|
||||
pub fn try_write_value(&self) -> Option<UntrackedWriteGuard<T>> {
|
||||
self.value
|
||||
.try_get_value()
|
||||
.and_then(|inner| UntrackedWriteGuard::try_new(inner))
|
||||
}
|
||||
|
||||
/// Returns a write guard to the stored data.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_write_value`] for a version without panic.
|
||||
#[track_caller]
|
||||
pub fn write_value(&self) -> UntrackedWriteGuard<T> {
|
||||
self.try_write_value().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
|
||||
/// Updates the current value by applying the given closure, returning the return value of the
|
||||
/// closure, or `None` if the value has already been disposed.
|
||||
pub fn try_update_value<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&mut T) -> U,
|
||||
) -> Option<U> {
|
||||
self.value
|
||||
.try_get_value()
|
||||
.map(|inner| fun(&mut *inner.write().or_poisoned()))
|
||||
}
|
||||
|
||||
/// Updates the value within [`StoredValue`] by applying a function to it.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_update_value`] for a version without panic.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
///
|
||||
/// #[derive(Default)] // Does not implement Clone
|
||||
/// struct Data {
|
||||
/// rows: Vec<u8>,
|
||||
/// }
|
||||
///
|
||||
/// let data = StoredValue::new(Data::default());
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static.
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let push_next = move || {
|
||||
/// data.update_value(|inner| match inner.rows.last().as_deref() {
|
||||
/// Some(n) => inner.rows.push(n + 1),
|
||||
/// None => inner.rows.push(0),
|
||||
/// })
|
||||
/// };
|
||||
///
|
||||
/// data.update_value(|inner| inner.rows = vec![5, 6, 7]);
|
||||
/// data.with_value(|inner| assert_eq!(inner.rows.last(), Some(&7)));
|
||||
///
|
||||
/// push_next();
|
||||
/// data.with_value(|inner| assert_eq!(inner.rows.last(), Some(&8)));
|
||||
///
|
||||
/// data.update_value(|inner| {
|
||||
/// std::mem::take(inner) // sets Data back to default
|
||||
/// });
|
||||
/// data.with_value(|inner| assert!(inner.rows.is_empty()));
|
||||
/// ```
|
||||
pub fn update_value<U>(&self, fun: impl FnOnce(&mut T) -> U) {
|
||||
self.try_update_value(fun);
|
||||
}
|
||||
|
||||
/// Sets the value within [`StoredValue`].
|
||||
///
|
||||
/// Returns [`Some`] containing the passed value if the owner of the reactive node has been
|
||||
/// disposed.
|
||||
///
|
||||
/// For types that do not implement [`Clone`], or in cases where allocating the entire object
|
||||
/// would be too expensive, prefer [`StoredValue::try_update_value`].
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
/// # use reactive_graph::traits::Dispose;
|
||||
///
|
||||
/// let data = StoredValue::new(String::default());
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static.
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let say_hello = move || {
|
||||
/// // Note that using the `update` methods would be more efficient here.
|
||||
/// data.try_set_value("Hello, World!".into())
|
||||
/// };
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let reset = move || {
|
||||
/// // Note that using the `update` methods would be more efficient here.
|
||||
/// data.try_set_value(Default::default())
|
||||
/// };
|
||||
/// assert_eq!(data.get_value(), "");
|
||||
///
|
||||
/// // None is returned because the value was able to be updated
|
||||
/// assert_eq!(say_hello(), None);
|
||||
///
|
||||
/// assert_eq!(data.get_value(), "Hello, World!");
|
||||
///
|
||||
/// reset();
|
||||
/// assert_eq!(data.get_value(), "");
|
||||
///
|
||||
/// // You should not call dispose yourself in normal user code.
|
||||
/// // This is shown here for the sake of the example.
|
||||
/// data.dispose();
|
||||
///
|
||||
/// // The reactive owner is disposed, so the value we intended to set is now
|
||||
/// // returned as some.
|
||||
/// assert_eq!(say_hello().as_deref(), Some("Hello, World!"));
|
||||
/// assert_eq!(reset().as_deref(), Some(""));
|
||||
/// ```
|
||||
pub fn try_set_value(&self, value: T) -> Option<T> {
|
||||
match self.value.try_get_value() {
|
||||
Some(inner) => {
|
||||
*inner.write().or_poisoned() = value;
|
||||
None
|
||||
}
|
||||
None => Some(value),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sets the value within [`StoredValue`].
|
||||
///
|
||||
/// For types that do not implement [`Clone`], or in cases where allocating the entire object
|
||||
/// would be too expensive, prefer [`StoredValue::update_value`].
|
||||
///
|
||||
/// # Panics
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_set_value`] for a version without panic.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
///
|
||||
/// let data = StoredValue::new(10);
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static.
|
||||
/// // *NOTE* this is not the same thing as a derived signal!
|
||||
/// // *NOTE* this will not be automatically rerun as StoredValue is NOT reactive!
|
||||
/// let maxout = move || data.set_value(u8::MAX);
|
||||
/// let zero = move || data.set_value(u8::MIN);
|
||||
///
|
||||
/// maxout();
|
||||
/// assert_eq!(data.get_value(), u8::MAX);
|
||||
///
|
||||
/// zero();
|
||||
/// assert_eq!(data.get_value(), u8::MIN);
|
||||
/// ```
|
||||
pub fn set_value(&self, value: T) {
|
||||
self.update_value(|n| *n = value);
|
||||
.and_then(|inner| inner.try_write_value())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -380,90 +156,39 @@ impl<T, S> IsDisposed for StoredValue<T, S> {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S: Storage<Arc<RwLock<T>>>> StoredValue<T, S>
|
||||
where
|
||||
T: Clone + 'static,
|
||||
{
|
||||
/// Returns the value within [`StoredValue`] by cloning.
|
||||
///
|
||||
/// Returns [`Some`] containing the value if the owner of the reactive node has not been
|
||||
/// disposed. When disposed, returns [`None`].
|
||||
///
|
||||
/// See [`StoredValue::try_with_value`] for a version that avoids cloning. See
|
||||
/// [`StoredValue::get_value`] for a version that clones, but panics if the node is disposed.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
/// # use reactive_graph::traits::Dispose;
|
||||
///
|
||||
/// // u8 is practically free to clone.
|
||||
/// let data: StoredValue<u8> = StoredValue::new(10);
|
||||
///
|
||||
/// // Larger data structures can become very expensive to clone.
|
||||
/// // You may prefer to use StoredValue::try_with_value.
|
||||
/// let _expensive: StoredValue<Vec<String>> = StoredValue::new(vec![]);
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static
|
||||
/// let maxout = move || data.set_value(u8::MAX);
|
||||
/// let zero = move || data.set_value(u8::MIN);
|
||||
///
|
||||
/// maxout();
|
||||
/// assert_eq!(data.try_get_value(), Some(u8::MAX));
|
||||
///
|
||||
/// zero();
|
||||
/// assert_eq!(data.try_get_value(), Some(u8::MIN));
|
||||
///
|
||||
/// // You should not call dispose yourself in normal user code.
|
||||
/// // This is shown here for the sake of the example.
|
||||
/// data.dispose();
|
||||
///
|
||||
/// assert_eq!(data.try_get_value(), None);
|
||||
/// ```
|
||||
pub fn try_get_value(&self) -> Option<T> {
|
||||
self.try_with_value(T::clone)
|
||||
}
|
||||
|
||||
/// Returns the value within [`StoredValue`] by cloning.
|
||||
///
|
||||
/// See [`StoredValue::with_value`] for a version that avoids cloning.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function panics when called after the owner of the reactive node has been disposed.
|
||||
/// See [`StoredValue::try_get_value`] for a version without panic.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```rust
|
||||
/// # use reactive_graph::owner::StoredValue; let owner = reactive_graph::owner::Owner::new(); owner.set();
|
||||
///
|
||||
/// // u8 is practically free to clone.
|
||||
/// let data: StoredValue<u8> = StoredValue::new(10);
|
||||
///
|
||||
/// // Larger data structures can become very expensive to clone.
|
||||
/// // You may prefer to use StoredValue::try_with_value.
|
||||
/// let _expensive: StoredValue<Vec<String>> = StoredValue::new(vec![]);
|
||||
///
|
||||
/// // Easy to move into closures because StoredValue is Copy + 'static
|
||||
/// let maxout = move || data.set_value(u8::MAX);
|
||||
/// let zero = move || data.set_value(u8::MIN);
|
||||
///
|
||||
/// maxout();
|
||||
/// assert_eq!(data.get_value(), u8::MAX);
|
||||
///
|
||||
/// zero();
|
||||
/// assert_eq!(data.get_value(), u8::MIN);
|
||||
/// ```
|
||||
pub fn get_value(&self) -> T {
|
||||
self.with_value(T::clone)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Dispose for StoredValue<T, S> {
|
||||
fn dispose(self) {
|
||||
self.value.dispose();
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> From<ArcStoredValue<T>> for StoredValue<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
{
|
||||
#[track_caller]
|
||||
fn from(value: ArcStoredValue<T>) -> Self {
|
||||
StoredValue {
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: Location::caller(),
|
||||
value: ArenaItem::new(value),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> From<StoredValue<T, S>> for ArcStoredValue<T>
|
||||
where
|
||||
S: Storage<ArcStoredValue<T>>,
|
||||
{
|
||||
#[track_caller]
|
||||
fn from(value: StoredValue<T, S>) -> Self {
|
||||
value
|
||||
.value
|
||||
.try_get_value()
|
||||
.unwrap_or_else(unwrap_signal!(value))
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a new [`StoredValue`].
|
||||
#[inline(always)]
|
||||
#[track_caller]
|
||||
|
||||
@@ -52,7 +52,7 @@ use crate::{
|
||||
effect::Effect,
|
||||
graph::{Observer, Source, Subscriber, ToAnySource},
|
||||
owner::Owner,
|
||||
signal::{arc_signal, ArcReadSignal},
|
||||
signal::{arc_signal, guards::UntrackedWriteGuard, ArcReadSignal},
|
||||
};
|
||||
use any_spawner::Executor;
|
||||
use futures::{Stream, StreamExt};
|
||||
@@ -639,3 +639,189 @@ pub fn panic_getting_disposed_signal(
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`Read`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait ReadValue: Sized + DefinedAt {
|
||||
/// The guard type that will be returned, which can be dereferenced to the value.
|
||||
type Value: Deref;
|
||||
|
||||
/// Returns the non-reactive guard, or `None` if the value has already been disposed.
|
||||
#[track_caller]
|
||||
fn try_read_value(&self) -> Option<Self::Value>;
|
||||
|
||||
/// Returns the non-reactive guard.
|
||||
///
|
||||
/// # Panics
|
||||
/// Panics if you try to access a value that has been disposed.
|
||||
#[track_caller]
|
||||
fn read_value(&self) -> Self::Value {
|
||||
self.try_read_value().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`With`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait WithValue: DefinedAt {
|
||||
/// The type of the value contained in the value.
|
||||
type Value: ?Sized;
|
||||
|
||||
/// Applies the closure to the value, non-reactively, and returns the result,
|
||||
/// or `None` if the value has already been disposed.
|
||||
#[track_caller]
|
||||
fn try_with_value<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U>;
|
||||
|
||||
/// Applies the closure to the value, non-reactively, and returns the result.
|
||||
///
|
||||
/// # Panics
|
||||
/// Panics if you try to access a value that has been disposed.
|
||||
#[track_caller]
|
||||
fn with_value<U>(&self, fun: impl FnOnce(&Self::Value) -> U) -> U {
|
||||
self.try_with_value(fun)
|
||||
.unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> WithValue for T
|
||||
where
|
||||
T: DefinedAt + ReadValue,
|
||||
{
|
||||
type Value = <<Self as ReadValue>::Value as Deref>::Target;
|
||||
|
||||
fn try_with_value<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
self.try_read_value().map(|value| fun(&value))
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`Get`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait GetValue: DefinedAt {
|
||||
/// The type of the value contained in the value.
|
||||
type Value: Clone;
|
||||
|
||||
/// Clones and returns the value of the value, non-reactively,
|
||||
/// or `None` if the value has already been disposed.
|
||||
#[track_caller]
|
||||
fn try_get_value(&self) -> Option<Self::Value>;
|
||||
|
||||
/// Clones and returns the value of the value, non-reactively.
|
||||
///
|
||||
/// # Panics
|
||||
/// Panics if you try to access a value that has been disposed.
|
||||
#[track_caller]
|
||||
fn get_value(&self) -> Self::Value {
|
||||
self.try_get_value().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> GetValue for T
|
||||
where
|
||||
T: WithValue,
|
||||
T::Value: Clone,
|
||||
{
|
||||
type Value = <Self as WithValue>::Value;
|
||||
|
||||
fn try_get_value(&self) -> Option<Self::Value> {
|
||||
self.try_with_value(Self::Value::clone)
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`Write`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait WriteValue: Sized + DefinedAt {
|
||||
/// The type of the value's value.
|
||||
type Value: Sized + 'static;
|
||||
|
||||
/// Returns a non-reactive write guard, or `None` if the value has already been disposed.
|
||||
#[track_caller]
|
||||
fn try_write_value(&self) -> Option<UntrackedWriteGuard<Self::Value>>;
|
||||
|
||||
/// Returns a non-reactive write guard.
|
||||
///
|
||||
/// # Panics
|
||||
/// Panics if you try to access a value that has been disposed.
|
||||
#[track_caller]
|
||||
fn write_value(&self) -> UntrackedWriteGuard<Self::Value> {
|
||||
self.try_write_value().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`Update`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait UpdateValue: DefinedAt {
|
||||
/// The type of the value contained in the value.
|
||||
type Value;
|
||||
|
||||
/// Updates the value, returning the value that is
|
||||
/// returned by the update function, or `None` if the value has already been disposed.
|
||||
#[track_caller]
|
||||
fn try_update_value<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&mut Self::Value) -> U,
|
||||
) -> Option<U>;
|
||||
|
||||
/// Updates the value.
|
||||
#[track_caller]
|
||||
fn update_value(&self, fun: impl FnOnce(&mut Self::Value)) {
|
||||
self.try_update_value(fun);
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> UpdateValue for T
|
||||
where
|
||||
T: WriteValue,
|
||||
{
|
||||
type Value = <Self as WriteValue>::Value;
|
||||
|
||||
#[track_caller]
|
||||
fn try_update_value<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&mut Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
let mut guard = self.try_write_value()?;
|
||||
Some(fun(&mut *guard))
|
||||
}
|
||||
}
|
||||
|
||||
/// A variation of the [`Set`] trait that provides a signposted "always-non-reactive" API.
|
||||
/// E.g. for [`StoredValue`](`crate::owner::StoredValue`).
|
||||
pub trait SetValue: DefinedAt {
|
||||
/// The type of the value contained in the value.
|
||||
type Value;
|
||||
|
||||
/// Updates the value by replacing it, non-reactively.
|
||||
///
|
||||
/// If the value has already been disposed, returns `Some(value)` with the value that was
|
||||
/// passed in. Otherwise, returns `None`.
|
||||
#[track_caller]
|
||||
fn try_set_value(&self, value: Self::Value) -> Option<Self::Value>;
|
||||
|
||||
/// Updates the value by replacing it, non-reactively.
|
||||
#[track_caller]
|
||||
fn set_value(&self, value: Self::Value) {
|
||||
self.try_set_value(value);
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> SetValue for T
|
||||
where
|
||||
T: WriteValue,
|
||||
{
|
||||
type Value = <Self as WriteValue>::Value;
|
||||
|
||||
fn try_set_value(&self, value: Self::Value) -> Option<Self::Value> {
|
||||
// Unlike most other traits, for these None actually means success:
|
||||
if let Some(mut guard) = self.try_write_value() {
|
||||
*guard = value;
|
||||
None
|
||||
} else {
|
||||
Some(value)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,15 +3,30 @@
|
||||
/// Types that abstract over signals with values that can be read.
|
||||
pub mod read {
|
||||
use crate::{
|
||||
computed::{ArcMemo, Memo},
|
||||
computed::{ArcMemo, Memo, MemoInner},
|
||||
graph::untrack,
|
||||
owner::{ArenaItem, FromLocal, LocalStorage, Storage, SyncStorage},
|
||||
signal::{ArcReadSignal, ArcRwSignal, ReadSignal, RwSignal},
|
||||
traits::{DefinedAt, Dispose, Get, With, WithUntracked},
|
||||
owner::{
|
||||
ArcStoredValue, ArenaItem, FromLocal, LocalStorage, Storage,
|
||||
SyncStorage,
|
||||
},
|
||||
signal::{
|
||||
guards::{Mapped, Plain, ReadGuard},
|
||||
ArcReadSignal, ArcRwSignal, ReadSignal, RwSignal,
|
||||
},
|
||||
traits::{
|
||||
DefinedAt, Dispose, Get, Read, ReadUntracked, ReadValue, Track,
|
||||
With, WithValue,
|
||||
},
|
||||
unwrap_signal,
|
||||
};
|
||||
use send_wrapper::SendWrapper;
|
||||
use std::{panic::Location, sync::Arc};
|
||||
use std::{
|
||||
borrow::Borrow,
|
||||
fmt::Display,
|
||||
ops::Deref,
|
||||
panic::Location,
|
||||
sync::{Arc, RwLock},
|
||||
};
|
||||
|
||||
/// Possibilities for the inner type of a [`Signal`].
|
||||
pub enum SignalTypes<T, S = SyncStorage>
|
||||
@@ -24,6 +39,8 @@ pub mod read {
|
||||
Memo(ArcMemo<T, S>),
|
||||
/// A derived signal.
|
||||
DerivedSignal(Arc<dyn Fn() -> T + Send + Sync>),
|
||||
/// A static, stored value.
|
||||
Stored(ArcStoredValue<T>),
|
||||
}
|
||||
|
||||
impl<T, S> Clone for SignalTypes<T, S>
|
||||
@@ -35,6 +52,7 @@ pub mod read {
|
||||
Self::ReadSignal(arg0) => Self::ReadSignal(arg0.clone()),
|
||||
Self::Memo(arg0) => Self::Memo(arg0.clone()),
|
||||
Self::DerivedSignal(arg0) => Self::DerivedSignal(arg0.clone()),
|
||||
Self::Stored(arg0) => Self::Stored(arg0.clone()),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -52,6 +70,9 @@ pub mod read {
|
||||
Self::DerivedSignal(_) => {
|
||||
f.debug_tuple("DerivedSignal").finish()
|
||||
}
|
||||
Self::Stored(arg0) => {
|
||||
f.debug_tuple("Static").field(arg0).finish()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -168,6 +189,39 @@ pub mod read {
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Moves a static, nonreactive value into a signal, backed by [`ArcStoredValue`].
|
||||
#[track_caller]
|
||||
pub fn stored(value: T) -> Self {
|
||||
Self {
|
||||
inner: SignalTypes::Stored(ArcStoredValue::new(value)),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> ArcSignal<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
/// Subscribes to this signal in the current reactive scope without doing anything with its value.
|
||||
#[track_caller]
|
||||
pub fn track(&self) {
|
||||
match &self.inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.track();
|
||||
}
|
||||
SignalTypes::Memo(i) => {
|
||||
i.track();
|
||||
}
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
i();
|
||||
}
|
||||
// Doesn't change.
|
||||
SignalTypes::Stored(_) => {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Default for ArcSignal<T, SyncStorage>
|
||||
@@ -175,7 +229,7 @@ pub mod read {
|
||||
T: Default + Send + Sync + 'static,
|
||||
{
|
||||
fn default() -> Self {
|
||||
Self::derive(|| Default::default())
|
||||
Self::stored(Default::default())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -231,24 +285,6 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> WithUntracked for ArcSignal<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
type Value = T;
|
||||
|
||||
fn try_with_untracked<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
match &self.inner {
|
||||
SignalTypes::ReadSignal(i) => i.try_with_untracked(fun),
|
||||
SignalTypes::Memo(i) => i.try_with_untracked(fun),
|
||||
SignalTypes::DerivedSignal(i) => Some(untrack(|| fun(&i()))),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> With for ArcSignal<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
@@ -264,10 +300,63 @@ pub mod read {
|
||||
SignalTypes::ReadSignal(i) => i.try_with(fun),
|
||||
SignalTypes::Memo(i) => i.try_with(fun),
|
||||
SignalTypes::DerivedSignal(i) => Some(fun(&i())),
|
||||
SignalTypes::Stored(i) => i.try_with_value(fun),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> ReadUntracked for ArcSignal<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
match &self.inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.try_read_untracked().map(SignalReadGuard::Read)
|
||||
}
|
||||
SignalTypes::Memo(i) => {
|
||||
i.try_read_untracked().map(SignalReadGuard::Memo)
|
||||
}
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
Some(SignalReadGuard::Owned(untrack(|| i())))
|
||||
}
|
||||
SignalTypes::Stored(i) => {
|
||||
i.try_read_value().map(SignalReadGuard::Read)
|
||||
}
|
||||
}
|
||||
.map(ReadGuard::new)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Read for ArcSignal<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read(&self) -> Option<Self::Value> {
|
||||
match &self.inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.try_read().map(SignalReadGuard::Read)
|
||||
}
|
||||
SignalTypes::Memo(i) => i.try_read().map(SignalReadGuard::Memo),
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
Some(SignalReadGuard::Owned(i()))
|
||||
}
|
||||
SignalTypes::Stored(i) => {
|
||||
i.try_read_value().map(SignalReadGuard::Read)
|
||||
}
|
||||
}
|
||||
.map(ReadGuard::new)
|
||||
}
|
||||
|
||||
fn read(&self) -> Self::Value {
|
||||
self.try_read().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
/// A wrapper for any kind of arena-allocated reactive signal:
|
||||
/// an [`ReadSignal`], [`Memo`], [`RwSignal`], or derived signal closure.
|
||||
///
|
||||
@@ -343,31 +432,6 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> WithUntracked for Signal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = T;
|
||||
|
||||
fn try_with_untracked<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
self.inner
|
||||
// clone the inner Arc type and release the lock
|
||||
// prevents deadlocking if the derived value includes taking a lock on the arena
|
||||
.try_with_value(Clone::clone)
|
||||
.and_then(|inner| match &inner {
|
||||
SignalTypes::ReadSignal(i) => i.try_with_untracked(fun),
|
||||
SignalTypes::Memo(i) => i.try_with_untracked(fun),
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
Some(untrack(|| fun(&i())))
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> With for Signal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
@@ -387,10 +451,79 @@ pub mod read {
|
||||
SignalTypes::ReadSignal(i) => i.try_with(fun),
|
||||
SignalTypes::Memo(i) => i.try_with(fun),
|
||||
SignalTypes::DerivedSignal(i) => Some(fun(&i())),
|
||||
SignalTypes::Stored(i) => i.try_with_value(fun),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> ReadUntracked for Signal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
self.inner
|
||||
// clone the inner Arc type and release the lock
|
||||
// prevents deadlocking if the derived value includes taking a lock on the arena
|
||||
.try_with_value(Clone::clone)
|
||||
.and_then(|inner| {
|
||||
match &inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.try_read_untracked().map(SignalReadGuard::Read)
|
||||
}
|
||||
SignalTypes::Memo(i) => {
|
||||
i.try_read_untracked().map(SignalReadGuard::Memo)
|
||||
}
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
Some(SignalReadGuard::Owned(untrack(|| i())))
|
||||
}
|
||||
SignalTypes::Stored(i) => {
|
||||
i.try_read_value().map(SignalReadGuard::Read)
|
||||
}
|
||||
}
|
||||
.map(ReadGuard::new)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Read for Signal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read(&self) -> Option<Self::Value> {
|
||||
self.inner
|
||||
// clone the inner Arc type and release the lock
|
||||
// prevents deadlocking if the derived value includes taking a lock on the arena
|
||||
.try_with_value(Clone::clone)
|
||||
.and_then(|inner| {
|
||||
match &inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.try_read().map(SignalReadGuard::Read)
|
||||
}
|
||||
SignalTypes::Memo(i) => {
|
||||
i.try_read().map(SignalReadGuard::Memo)
|
||||
}
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
Some(SignalReadGuard::Owned(i()))
|
||||
}
|
||||
SignalTypes::Stored(i) => {
|
||||
i.try_read_value().map(SignalReadGuard::Read)
|
||||
}
|
||||
}
|
||||
.map(ReadGuard::new)
|
||||
})
|
||||
}
|
||||
|
||||
fn read(&self) -> Self::Value {
|
||||
self.try_read().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Signal<T>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
@@ -433,6 +566,18 @@ pub mod read {
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Moves a static, nonreactive value into a signal, backed by [`ArcStoredValue`].
|
||||
#[track_caller]
|
||||
pub fn stored(value: T) -> Self {
|
||||
Self {
|
||||
inner: ArenaItem::new_with_storage(SignalTypes::Stored(
|
||||
ArcStoredValue::new(value),
|
||||
)),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Signal<T, LocalStorage>
|
||||
@@ -460,6 +605,49 @@ pub mod read {
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Moves a static, nonreactive value into a signal, backed by [`ArcStoredValue`].
|
||||
/// Works like [`Signal::stored`] but uses [`LocalStorage`].
|
||||
#[track_caller]
|
||||
pub fn stored_local(value: T) -> Self {
|
||||
Self {
|
||||
inner: ArenaItem::new_local(SignalTypes::Stored(
|
||||
ArcStoredValue::new(value),
|
||||
)),
|
||||
#[cfg(debug_assertions)]
|
||||
defined_at: std::panic::Location::caller(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Signal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
/// Subscribes to this signal in the current reactive scope without doing anything with its value.
|
||||
#[track_caller]
|
||||
pub fn track(&self) {
|
||||
let inner = self
|
||||
.inner
|
||||
// clone the inner Arc type and release the lock
|
||||
// prevents deadlocking if the derived value includes taking a lock on the arena
|
||||
.try_with_value(Clone::clone)
|
||||
.unwrap_or_else(unwrap_signal!(self));
|
||||
match inner {
|
||||
SignalTypes::ReadSignal(i) => {
|
||||
i.track();
|
||||
}
|
||||
SignalTypes::Memo(i) => {
|
||||
i.track();
|
||||
}
|
||||
SignalTypes::DerivedSignal(i) => {
|
||||
i();
|
||||
}
|
||||
// Doesn't change.
|
||||
SignalTypes::Stored(_) => {}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> Default for Signal<T>
|
||||
@@ -467,7 +655,7 @@ pub mod read {
|
||||
T: Send + Sync + Default + 'static,
|
||||
{
|
||||
fn default() -> Self {
|
||||
Self::derive(|| Default::default())
|
||||
Self::stored(Default::default())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -476,34 +664,34 @@ pub mod read {
|
||||
T: Default + 'static,
|
||||
{
|
||||
fn default() -> Self {
|
||||
Self::derive_local(|| Default::default())
|
||||
Self::stored_local(Default::default())
|
||||
}
|
||||
}
|
||||
|
||||
impl<T: Clone + Send + Sync + 'static> From<T> for ArcSignal<T, SyncStorage> {
|
||||
impl<T: Send + Sync + 'static> From<T> for ArcSignal<T, SyncStorage> {
|
||||
#[track_caller]
|
||||
fn from(value: T) -> Self {
|
||||
Self::derive(move || value.clone())
|
||||
ArcSignal::stored(value)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> From<T> for Signal<T>
|
||||
where
|
||||
T: Clone + Send + Sync + 'static,
|
||||
T: Send + Sync + 'static,
|
||||
{
|
||||
#[track_caller]
|
||||
fn from(value: T) -> Self {
|
||||
Self::derive(move || value.clone())
|
||||
Self::stored(value)
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> From<T> for Signal<T, LocalStorage>
|
||||
where
|
||||
T: Clone + 'static,
|
||||
T: 'static,
|
||||
{
|
||||
#[track_caller]
|
||||
fn from(value: T) -> Self {
|
||||
Self::derive_local(move || value.clone())
|
||||
Self::stored_local(value)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -715,23 +903,6 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> WithUntracked for MaybeSignal<T, S>
|
||||
where
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = T;
|
||||
|
||||
fn try_with_untracked<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
match self {
|
||||
Self::Static(t) => Some(fun(t)),
|
||||
Self::Dynamic(s) => s.try_with_untracked(fun),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> With for MaybeSignal<T, S>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
@@ -750,6 +921,44 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> ReadUntracked for MaybeSignal<T, S>
|
||||
where
|
||||
T: Clone,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
match self {
|
||||
Self::Static(t) => {
|
||||
Some(ReadGuard::new(SignalReadGuard::Owned(t.clone())))
|
||||
}
|
||||
Self::Dynamic(s) => s.try_read_untracked(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Read for MaybeSignal<T, S>
|
||||
where
|
||||
T: Clone,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
type Value = ReadGuard<T, SignalReadGuard<T, S>>;
|
||||
|
||||
fn try_read(&self) -> Option<Self::Value> {
|
||||
match self {
|
||||
Self::Static(t) => {
|
||||
Some(ReadGuard::new(SignalReadGuard::Owned(t.clone())))
|
||||
}
|
||||
Self::Dynamic(s) => s.try_read(),
|
||||
}
|
||||
}
|
||||
|
||||
fn read(&self) -> Self::Value {
|
||||
self.try_read().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> MaybeSignal<T>
|
||||
where
|
||||
T: Send + Sync,
|
||||
@@ -771,6 +980,21 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> MaybeSignal<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<T, S>> + Storage<T>,
|
||||
{
|
||||
/// Subscribes to this signal in the current reactive scope without doing anything with its value.
|
||||
#[track_caller]
|
||||
pub fn track(&self) {
|
||||
match self {
|
||||
Self::Static(_) => {}
|
||||
Self::Dynamic(signal) => signal.track(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> From<T> for MaybeSignal<T, SyncStorage>
|
||||
where
|
||||
SyncStorage: Storage<T>,
|
||||
@@ -893,7 +1117,7 @@ pub mod read {
|
||||
|
||||
impl<S> From<&str> for MaybeSignal<String, S>
|
||||
where
|
||||
S: Storage<String>,
|
||||
S: Storage<String> + Storage<Arc<RwLock<String>>>,
|
||||
{
|
||||
fn from(value: &str) -> Self {
|
||||
Self::Static(value.to_string())
|
||||
@@ -968,23 +1192,6 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> WithUntracked for MaybeProp<T, S>
|
||||
where
|
||||
S: Storage<SignalTypes<Option<T>, S>> + Storage<Option<T>>,
|
||||
{
|
||||
type Value = Option<T>;
|
||||
|
||||
fn try_with_untracked<U>(
|
||||
&self,
|
||||
fun: impl FnOnce(&Self::Value) -> U,
|
||||
) -> Option<U> {
|
||||
match &self.0 {
|
||||
None => Some(fun(&None)),
|
||||
Some(inner) => inner.try_with_untracked(fun),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> With for MaybeProp<T, S>
|
||||
where
|
||||
T: Send + Sync + 'static,
|
||||
@@ -1003,6 +1210,40 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> ReadUntracked for MaybeProp<T, S>
|
||||
where
|
||||
T: Clone,
|
||||
S: Storage<SignalTypes<Option<T>, S>> + Storage<Option<T>>,
|
||||
{
|
||||
type Value = ReadGuard<Option<T>, SignalReadGuard<Option<T>, S>>;
|
||||
|
||||
fn try_read_untracked(&self) -> Option<Self::Value> {
|
||||
match &self.0 {
|
||||
None => Some(ReadGuard::new(SignalReadGuard::Owned(None))),
|
||||
Some(inner) => inner.try_read_untracked(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Read for MaybeProp<T, S>
|
||||
where
|
||||
T: Clone,
|
||||
S: Storage<SignalTypes<Option<T>, S>> + Storage<Option<T>>,
|
||||
{
|
||||
type Value = ReadGuard<Option<T>, SignalReadGuard<Option<T>, S>>;
|
||||
|
||||
fn try_read(&self) -> Option<Self::Value> {
|
||||
match &self.0 {
|
||||
None => Some(ReadGuard::new(SignalReadGuard::Owned(None))),
|
||||
Some(inner) => inner.try_read(),
|
||||
}
|
||||
}
|
||||
|
||||
fn read(&self) -> Self::Value {
|
||||
self.try_read().unwrap_or_else(unwrap_signal!(self))
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> MaybeProp<T>
|
||||
where
|
||||
T: Send + Sync,
|
||||
@@ -1016,6 +1257,21 @@ pub mod read {
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> MaybeProp<T, S>
|
||||
where
|
||||
T: 'static,
|
||||
S: Storage<SignalTypes<Option<T>, S>> + Storage<Option<T>>,
|
||||
{
|
||||
/// Subscribes to this signal in the current reactive scope without doing anything with its value.
|
||||
#[track_caller]
|
||||
pub fn track(&self) {
|
||||
match &self.0 {
|
||||
None => {}
|
||||
Some(signal) => signal.track(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T> From<T> for MaybeProp<T>
|
||||
where
|
||||
SyncStorage: Storage<Option<T>>,
|
||||
@@ -1242,6 +1498,76 @@ pub mod read {
|
||||
Self(Some(MaybeSignal::from_local(Some(value.to_string()))))
|
||||
}
|
||||
}
|
||||
|
||||
/// The content of a [`Signal`] wrapper read guard, variable depending on the signal type.
|
||||
#[derive(Debug)]
|
||||
pub enum SignalReadGuard<T: 'static, S: Storage<T>> {
|
||||
/// A read signal guard.
|
||||
Read(ReadGuard<T, Plain<T>>),
|
||||
/// A memo guard.
|
||||
Memo(ReadGuard<T, Mapped<Plain<MemoInner<T, S>>, T>>),
|
||||
/// A fake guard for derived signals, the content had to actually be cloned, so it's not a guard but we pretend it is.
|
||||
Owned(T),
|
||||
}
|
||||
|
||||
impl<T, S> Clone for SignalReadGuard<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
T: Clone,
|
||||
Plain<T>: Clone,
|
||||
Mapped<Plain<MemoInner<T, S>>, T>: Clone,
|
||||
{
|
||||
fn clone(&self) -> Self {
|
||||
match self {
|
||||
SignalReadGuard::Read(i) => SignalReadGuard::Read(i.clone()),
|
||||
SignalReadGuard::Memo(i) => SignalReadGuard::Memo(i.clone()),
|
||||
SignalReadGuard::Owned(i) => SignalReadGuard::Owned(i.clone()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Deref for SignalReadGuard<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
type Target = T;
|
||||
fn deref(&self) -> &Self::Target {
|
||||
match self {
|
||||
SignalReadGuard::Read(i) => i,
|
||||
SignalReadGuard::Memo(i) => i,
|
||||
SignalReadGuard::Owned(i) => i,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Borrow<T> for SignalReadGuard<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
{
|
||||
fn borrow(&self) -> &T {
|
||||
self.deref()
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> PartialEq<T> for SignalReadGuard<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
T: PartialEq,
|
||||
{
|
||||
fn eq(&self, other: &T) -> bool {
|
||||
self.deref() == other
|
||||
}
|
||||
}
|
||||
|
||||
impl<T, S> Display for SignalReadGuard<T, S>
|
||||
where
|
||||
S: Storage<T>,
|
||||
T: Display,
|
||||
{
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
Display::fmt(&**self, f)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Types that abstract over the ability to update a signal.
|
||||
|
||||
88
reactive_graph/tests/cleanup.rs
Normal file
88
reactive_graph/tests/cleanup.rs
Normal file
@@ -0,0 +1,88 @@
|
||||
use reactive_graph::{
|
||||
computed::Memo,
|
||||
owner::{on_cleanup, Owner},
|
||||
signal::{RwSignal, Trigger},
|
||||
traits::{Dispose, GetUntracked, Track},
|
||||
};
|
||||
use std::sync::Arc;
|
||||
|
||||
#[test]
|
||||
fn cleanup_on_dispose() {
|
||||
let owner = Owner::new();
|
||||
owner.set();
|
||||
|
||||
struct ExecuteOnDrop(Option<Box<dyn FnOnce() + Send + Sync>>);
|
||||
|
||||
impl ExecuteOnDrop {
|
||||
fn new(f: impl FnOnce() + Send + Sync + 'static) -> Self {
|
||||
Self(Some(Box::new(f)))
|
||||
}
|
||||
}
|
||||
impl Drop for ExecuteOnDrop {
|
||||
fn drop(&mut self) {
|
||||
self.0.take().unwrap()();
|
||||
}
|
||||
}
|
||||
|
||||
let trigger = Trigger::new();
|
||||
|
||||
println!("STARTING");
|
||||
|
||||
let memo = Memo::new(move |_| {
|
||||
trigger.track();
|
||||
|
||||
// An example of why you might want to do this is that
|
||||
// when something goes out of reactive scope you want it to be cleaned up.
|
||||
// The cleaning up might have side effects, and those side effects might cause
|
||||
// re-renders where new `on_cleanup` are registered.
|
||||
let on_drop = ExecuteOnDrop::new(|| {
|
||||
on_cleanup(|| println!("Nested cleanup in progress."))
|
||||
});
|
||||
|
||||
on_cleanup(move || {
|
||||
println!("Cleanup in progress.");
|
||||
drop(on_drop)
|
||||
});
|
||||
});
|
||||
println!("Memo 1: {:?}", memo);
|
||||
memo.get_untracked(); // First cleanup registered.
|
||||
|
||||
memo.dispose(); // Cleanup not run here.
|
||||
|
||||
println!("Cleanup should have been executed.");
|
||||
|
||||
let memo = Memo::new(move |_| {
|
||||
// New cleanup registered. It'll panic here.
|
||||
on_cleanup(move || println!("Test passed."));
|
||||
});
|
||||
println!("Memo 2: {:?}", memo);
|
||||
println!("^ Note how the memos have the same key (different versions).");
|
||||
memo.get_untracked(); // First cleanup registered.
|
||||
|
||||
println!("Test passed.");
|
||||
|
||||
memo.dispose();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn leak_on_dispose() {
|
||||
let owner = Owner::new();
|
||||
owner.set();
|
||||
|
||||
let trigger = Trigger::new();
|
||||
|
||||
let value = Arc::new(());
|
||||
let weak = Arc::downgrade(&value);
|
||||
|
||||
let memo = Memo::new(move |_| {
|
||||
trigger.track();
|
||||
|
||||
RwSignal::new(value.clone());
|
||||
});
|
||||
|
||||
memo.get_untracked();
|
||||
|
||||
memo.dispose();
|
||||
|
||||
assert!(weak.upgrade().is_none()); // Should have been dropped.
|
||||
}
|
||||
@@ -258,3 +258,20 @@ where
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<Inner, Prev> DoubleEndedIterator for StoreFieldIter<Inner, Prev>
|
||||
where
|
||||
Inner: StoreField<Value = Prev> + Clone + 'static,
|
||||
Prev: IndexMut<usize> + 'static,
|
||||
Prev::Output: Sized + 'static,
|
||||
{
|
||||
fn next_back(&mut self) -> Option<Self::Item> {
|
||||
if self.len > self.idx {
|
||||
self.len -= 1;
|
||||
let field = AtIndex::new(self.inner.clone(), self.len);
|
||||
Some(field)
|
||||
} else {
|
||||
None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -682,3 +682,18 @@ where
|
||||
.map(|key| AtKeyed::new(self.inner.clone(), key))
|
||||
}
|
||||
}
|
||||
|
||||
impl<Inner, Prev, K, T> DoubleEndedIterator
|
||||
for StoreFieldKeyedIter<Inner, Prev, K, T>
|
||||
where
|
||||
Inner: StoreField<Value = Prev> + Clone + 'static,
|
||||
T: IndexMut<usize> + 'static,
|
||||
T::Output: Sized + 'static,
|
||||
for<'a> &'a T: IntoIterator,
|
||||
{
|
||||
fn next_back(&mut self) -> Option<Self::Item> {
|
||||
self.keys
|
||||
.pop_back()
|
||||
.map(|key| AtKeyed::new(self.inner.clone(), key))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -101,8 +101,9 @@ where
|
||||
let get = Memo::new({
|
||||
let key = key.clone_inplace();
|
||||
move |_| {
|
||||
query_map
|
||||
.with(|map| map.get(&key).and_then(|value| value.parse().ok()))
|
||||
query_map.with(|map| {
|
||||
map.get_str(&key).and_then(|value| value.parse().ok())
|
||||
})
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
@@ -14,7 +14,6 @@ mod method;
|
||||
mod navigate;
|
||||
pub mod nested_router;
|
||||
pub mod params;
|
||||
//mod router;
|
||||
mod ssr_mode;
|
||||
pub mod static_routes;
|
||||
|
||||
@@ -24,5 +23,4 @@ pub use leptos_router_macro::path;
|
||||
pub use matching::*;
|
||||
pub use method::*;
|
||||
pub use navigate::*;
|
||||
//pub use router::*;
|
||||
pub use ssr_mode::*;
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
use crate::location::{unescape, Url};
|
||||
use std::{borrow::Cow, mem, str::FromStr, sync::Arc};
|
||||
use std::{borrow::Cow, str::FromStr, sync::Arc};
|
||||
use thiserror::Error;
|
||||
|
||||
type ParamsMapInner = Vec<(Cow<'static, str>, String)>;
|
||||
type ParamsMapInner = Vec<(Cow<'static, str>, Vec<String>)>;
|
||||
|
||||
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
|
||||
pub struct ParamsMap(ParamsMapInner);
|
||||
@@ -21,34 +21,43 @@ impl ParamsMap {
|
||||
}
|
||||
|
||||
/// Inserts a value into the map.
|
||||
pub fn insert(&mut self, key: String, value: String) -> Option<String> {
|
||||
pub fn insert(&mut self, key: impl Into<Cow<'static, str>>, value: String) {
|
||||
let value = unescape(&value);
|
||||
|
||||
if let Some(prev) = self.0.iter().position(|(k, _)| k == &key) {
|
||||
return Some(mem::replace(&mut self.0[prev].1, value));
|
||||
let key = key.into();
|
||||
if let Some(prev) = self.0.iter_mut().find(|(k, _)| k == &key) {
|
||||
prev.1.push(value);
|
||||
} else {
|
||||
self.0.push((key, vec![value]));
|
||||
}
|
||||
|
||||
self.0.push((key.into(), value));
|
||||
None
|
||||
}
|
||||
|
||||
/// Gets an owned value from the map.
|
||||
/// Gets the most-recently-added value of this param from the map.
|
||||
pub fn get(&self, key: &str) -> Option<String> {
|
||||
self.0
|
||||
.iter()
|
||||
.find_map(|(k, v)| (k == key).then_some(v.to_owned()))
|
||||
self.get_str(key).map(ToOwned::to_owned)
|
||||
}
|
||||
|
||||
/// Gets a referenc to a value from the map.
|
||||
pub fn get_str(&self, key: &str) -> Option<&str> {
|
||||
/// Gets all references to a param of this name from the map.
|
||||
pub fn get_all(&self, key: &str) -> Option<Vec<String>> {
|
||||
self.0
|
||||
.iter()
|
||||
.find_map(|(k, v)| (k == key).then_some(v.as_str()))
|
||||
.find_map(|(k, v)| if k == key { Some(v.clone()) } else { None })
|
||||
}
|
||||
|
||||
/// Gets a reference to the most-recently-added value of this param from the map.
|
||||
pub fn get_str(&self, key: &str) -> Option<&str> {
|
||||
self.0.iter().find_map(|(k, v)| {
|
||||
if k == key {
|
||||
v.last().map(|i| i.as_str())
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Removes a value from the map.
|
||||
#[inline(always)]
|
||||
pub fn remove(&mut self, key: &str) -> Option<String> {
|
||||
pub fn remove(&mut self, key: &str) -> Option<Vec<String>> {
|
||||
for i in 0..self.0.len() {
|
||||
if self.0[i].0 == key {
|
||||
return Some(self.0.swap_remove(i).1);
|
||||
@@ -62,11 +71,13 @@ impl ParamsMap {
|
||||
let mut buf = String::new();
|
||||
if !self.0.is_empty() {
|
||||
buf.push('?');
|
||||
for (k, v) in &self.0 {
|
||||
buf.push_str(&Url::escape(k));
|
||||
buf.push('=');
|
||||
buf.push_str(&Url::escape(v));
|
||||
buf.push('&');
|
||||
for (k, vs) in &self.0 {
|
||||
for v in vs {
|
||||
buf.push_str(&Url::escape(k));
|
||||
buf.push('=');
|
||||
buf.push_str(&Url::escape(v));
|
||||
buf.push('&');
|
||||
}
|
||||
}
|
||||
if buf.len() > 1 {
|
||||
buf.pop();
|
||||
@@ -82,11 +93,12 @@ where
|
||||
V: Into<String>,
|
||||
{
|
||||
fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self {
|
||||
Self(
|
||||
iter.into_iter()
|
||||
.map(|(k, v)| (k.into(), v.into()))
|
||||
.collect(),
|
||||
)
|
||||
let mut map = Self::new();
|
||||
|
||||
for (key, value) in iter {
|
||||
map.insert(key, value.into());
|
||||
}
|
||||
map
|
||||
}
|
||||
}
|
||||
|
||||
@@ -95,13 +107,21 @@ impl IntoIterator for ParamsMap {
|
||||
type IntoIter = ParamsMapIter;
|
||||
|
||||
fn into_iter(self) -> Self::IntoIter {
|
||||
ParamsMapIter(self.0.into_iter())
|
||||
let inner = self.0.into_iter().fold(vec![], |mut c, (k, vs)| {
|
||||
for v in vs {
|
||||
c.push((k.clone(), v));
|
||||
}
|
||||
c
|
||||
});
|
||||
ParamsMapIter(inner.into_iter())
|
||||
}
|
||||
}
|
||||
|
||||
/// An iterator over the keys and values of a [`ParamsMap`].
|
||||
#[derive(Debug)]
|
||||
pub struct ParamsMapIter(<ParamsMapInner as IntoIterator>::IntoIter);
|
||||
pub struct ParamsMapIter(
|
||||
<Vec<(Cow<'static, str>, String)> as IntoIterator>::IntoIter,
|
||||
);
|
||||
|
||||
impl Iterator for ParamsMapIter {
|
||||
type Item = (Cow<'static, str>, String);
|
||||
@@ -201,3 +221,20 @@ impl PartialEq for ParamsError {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(all(test, feature = "ssr"))]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn paramsmap_to_query_string() {
|
||||
let mut map = ParamsMap::new();
|
||||
let key = "param".to_string();
|
||||
let value1 = "a".to_string();
|
||||
let value2 = "b".to_string();
|
||||
map.insert(key.clone(), value1);
|
||||
map.insert(key, value2);
|
||||
let query_string = map.to_query_string();
|
||||
assert_eq!(&query_string, "?param=a¶m=b")
|
||||
}
|
||||
}
|
||||
|
||||
1443
router/src/router.rs
1443
router/src/router.rs
File diff suppressed because it is too large
Load Diff
@@ -25,8 +25,8 @@ inventory = { version = "0.3.15", optional = true }
|
||||
dashmap = "6.0"
|
||||
once_cell = "1.19"
|
||||
|
||||
## servers
|
||||
# actix
|
||||
## servers
|
||||
# actix
|
||||
actix-web = { version = "4.8", optional = true }
|
||||
|
||||
# axum
|
||||
@@ -36,12 +36,12 @@ axum = { version = "0.7.5", optional = true, default-features = false, features
|
||||
tower = { version = "0.4.13", optional = true }
|
||||
tower-layer = { version = "0.3.2", optional = true }
|
||||
|
||||
## input encodings
|
||||
## input encodings
|
||||
serde_qs = { version = "0.13.0", optional = true }
|
||||
multer = { version = "3.1", optional = true }
|
||||
|
||||
## output encodings
|
||||
# serde
|
||||
## output encodings
|
||||
# serde
|
||||
serde_json = "1.0"
|
||||
serde-lite = { version = "0.5.0", features = ["derive"], optional = true }
|
||||
futures = "0.3.30"
|
||||
@@ -51,11 +51,7 @@ postcard = { version = "1", features = ["alloc"], optional = true }
|
||||
hyper = { version = "1.4", optional = true }
|
||||
bytes = "1.7"
|
||||
http-body-util = { version = "0.1.2", optional = true }
|
||||
rkyv = { version = "0.7.44", features = [
|
||||
"validation",
|
||||
"uuid",
|
||||
"strict",
|
||||
], optional = true }
|
||||
rkyv = { version = "0.8.8", optional = true }
|
||||
rmp-serde = { version = "1.3.0", optional = true }
|
||||
|
||||
# client
|
||||
@@ -72,7 +68,7 @@ web-sys = { version = "0.3.70", optional = true, features = [
|
||||
"AbortSignal",
|
||||
] }
|
||||
|
||||
# reqwest client
|
||||
# reqwest client
|
||||
reqwest = { version = "0.12.5", default-features = false, optional = true, features = [
|
||||
"multipart",
|
||||
"stream",
|
||||
|
||||
@@ -8,11 +8,19 @@ use bytes::Bytes;
|
||||
use futures::StreamExt;
|
||||
use http::Method;
|
||||
use rkyv::{
|
||||
de::deserializers::SharedDeserializeMap, ser::serializers::AllocSerializer,
|
||||
validation::validators::DefaultValidator, AlignedVec, Archive, CheckBytes,
|
||||
Deserialize, Serialize,
|
||||
api::high::{HighDeserializer, HighSerializer, HighValidator},
|
||||
bytecheck::CheckBytes,
|
||||
rancor,
|
||||
ser::allocator::ArenaHandle,
|
||||
util::AlignedVec,
|
||||
Archive, Deserialize, Serialize,
|
||||
};
|
||||
|
||||
type RkyvSerializer<'a> =
|
||||
HighSerializer<AlignedVec, ArenaHandle<'a>, rancor::Error>;
|
||||
type RkyvDeserializer = HighDeserializer<rancor::Error>;
|
||||
type RkyvValidator<'a> = HighValidator<'a, rancor::Error>;
|
||||
|
||||
/// Pass arguments and receive responses using `rkyv` in a `POST` request.
|
||||
pub struct Rkyv;
|
||||
|
||||
@@ -24,17 +32,16 @@ impl Encoding for Rkyv {
|
||||
impl<CustErr, T, Request> IntoReq<Rkyv, Request, CustErr> for T
|
||||
where
|
||||
Request: ClientReq<CustErr>,
|
||||
T: Serialize<AllocSerializer<1024>> + Send,
|
||||
T: Archive,
|
||||
T::Archived: for<'a> CheckBytes<DefaultValidator<'a>>
|
||||
+ Deserialize<T, SharedDeserializeMap>,
|
||||
T: Archive + for<'a> Serialize<RkyvSerializer<'a>>,
|
||||
T::Archived: Deserialize<T, RkyvDeserializer>
|
||||
+ for<'a> CheckBytes<RkyvValidator<'a>>,
|
||||
{
|
||||
fn into_req(
|
||||
self,
|
||||
path: &str,
|
||||
accepts: &str,
|
||||
) -> Result<Request, ServerFnError<CustErr>> {
|
||||
let encoded = rkyv::to_bytes::<T, 1024>(&self)
|
||||
let encoded = rkyv::to_bytes::<rancor::Error>(&self)
|
||||
.map_err(|e| ServerFnError::Serialization(e.to_string()))?;
|
||||
let bytes = Bytes::copy_from_slice(encoded.as_ref());
|
||||
Request::try_new_post_bytes(path, accepts, Rkyv::CONTENT_TYPE, bytes)
|
||||
@@ -44,13 +51,12 @@ where
|
||||
impl<CustErr, T, Request> FromReq<Rkyv, Request, CustErr> for T
|
||||
where
|
||||
Request: Req<CustErr> + Send + 'static,
|
||||
T: Serialize<AllocSerializer<1024>> + Send,
|
||||
T: Archive,
|
||||
T::Archived: for<'a> CheckBytes<DefaultValidator<'a>>
|
||||
+ Deserialize<T, SharedDeserializeMap>,
|
||||
T: Archive + for<'a> Serialize<RkyvSerializer<'a>>,
|
||||
T::Archived: Deserialize<T, RkyvDeserializer>
|
||||
+ for<'a> CheckBytes<RkyvValidator<'a>>,
|
||||
{
|
||||
async fn from_req(req: Request) -> Result<Self, ServerFnError<CustErr>> {
|
||||
let mut aligned = AlignedVec::new();
|
||||
let mut aligned = AlignedVec::<1024>::new();
|
||||
let mut body_stream = Box::pin(req.try_into_stream()?);
|
||||
while let Some(chunk) = body_stream.next().await {
|
||||
match chunk {
|
||||
@@ -64,7 +70,7 @@ where
|
||||
}
|
||||
}
|
||||
}
|
||||
rkyv::from_bytes::<T>(aligned.as_ref())
|
||||
rkyv::from_bytes::<T, rancor::Error>(aligned.as_ref())
|
||||
.map_err(|e| ServerFnError::Args(e.to_string()))
|
||||
}
|
||||
}
|
||||
@@ -72,14 +78,14 @@ where
|
||||
impl<CustErr, T, Response> IntoRes<Rkyv, Response, CustErr> for T
|
||||
where
|
||||
Response: Res<CustErr>,
|
||||
T: Serialize<AllocSerializer<1024>> + Send,
|
||||
T: Archive,
|
||||
T::Archived: for<'a> CheckBytes<DefaultValidator<'a>>
|
||||
+ Deserialize<T, SharedDeserializeMap>,
|
||||
T: Send,
|
||||
T: Archive + for<'a> Serialize<RkyvSerializer<'a>>,
|
||||
T::Archived: Deserialize<T, RkyvDeserializer>
|
||||
+ for<'a> CheckBytes<RkyvValidator<'a>>,
|
||||
{
|
||||
async fn into_res(self) -> Result<Response, ServerFnError<CustErr>> {
|
||||
let encoded = rkyv::to_bytes::<T, 1024>(&self)
|
||||
.map_err(|e| ServerFnError::Serialization(e.to_string()))?;
|
||||
let encoded = rkyv::to_bytes::<rancor::Error>(&self)
|
||||
.map_err(|e| ServerFnError::Serialization(format!("{e:?}")))?;
|
||||
let bytes = Bytes::copy_from_slice(encoded.as_ref());
|
||||
Response::try_from_bytes(Rkyv::CONTENT_TYPE, bytes)
|
||||
}
|
||||
@@ -88,14 +94,13 @@ where
|
||||
impl<CustErr, T, Response> FromRes<Rkyv, Response, CustErr> for T
|
||||
where
|
||||
Response: ClientRes<CustErr> + Send,
|
||||
T: Serialize<AllocSerializer<1024>> + Send,
|
||||
T: Archive,
|
||||
T::Archived: for<'a> CheckBytes<DefaultValidator<'a>>
|
||||
+ Deserialize<T, SharedDeserializeMap>,
|
||||
T: Archive + for<'a> Serialize<RkyvSerializer<'a>>,
|
||||
T::Archived: Deserialize<T, RkyvDeserializer>
|
||||
+ for<'a> CheckBytes<RkyvValidator<'a>>,
|
||||
{
|
||||
async fn from_res(res: Response) -> Result<Self, ServerFnError<CustErr>> {
|
||||
let data = res.try_into_bytes().await?;
|
||||
rkyv::from_bytes::<T>(&data)
|
||||
rkyv::from_bytes::<T, rancor::Error>(&data)
|
||||
.map_err(|e| ServerFnError::Deserialization(e.to_string()))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -505,12 +505,7 @@ pub fn server_macro_impl(
|
||||
PathInfo::Serde => quote! {
|
||||
#[serde(crate = #serde_path)]
|
||||
},
|
||||
PathInfo::Rkyv => {
|
||||
let rkyv_path = format!("{server_fn_path}::rkyv");
|
||||
quote! {
|
||||
#[archive(crate = #rkyv_path, check_bytes)]
|
||||
}
|
||||
}
|
||||
PathInfo::Rkyv => quote! {},
|
||||
PathInfo::None => quote! {},
|
||||
};
|
||||
|
||||
|
||||
@@ -11,6 +11,26 @@ use std::{
|
||||
sync::Arc,
|
||||
};
|
||||
|
||||
/// Declares that this type can be converted into some other type, which is a valid attribute value.
|
||||
pub trait IntoAttributeValue {
|
||||
/// The attribute value into which this type can be converted.
|
||||
type Output;
|
||||
|
||||
/// Consumes this value, transforming it into an attribute value.
|
||||
fn into_attribute_value(self) -> Self::Output;
|
||||
}
|
||||
|
||||
impl<T> IntoAttributeValue for T
|
||||
where
|
||||
T: AttributeValue,
|
||||
{
|
||||
type Output = Self;
|
||||
|
||||
fn into_attribute_value(self) -> Self::Output {
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
/// A possible value for an HTML attribute.
|
||||
pub trait AttributeValue: Send {
|
||||
/// The state that should be retained between building and rebuilding.
|
||||
|
||||
@@ -390,7 +390,7 @@ html_elements! {
|
||||
/// The `<template>` HTML element is a mechanism for holding HTML that is not to be rendered immediately when a page is loaded but may be instantiated subsequently during runtime using JavaScript.
|
||||
template HtmlTemplateElement [] true,
|
||||
/// The `<textarea>` HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.
|
||||
textarea HtmlTextAreaElement [autocomplete, cols, dirname, disabled, form, maxlength, minlength, name, placeholder, readonly, required, rows, wrap] true,
|
||||
textarea HtmlTextAreaElement [autocomplete, cols, dirname, disabled, form, maxlength, minlength, name, placeholder, readonly, required, rows, wrap] false,
|
||||
/// The `<tfoot>` HTML element defines a set of rows summarizing the columns of the table.
|
||||
tfoot HtmlTableSectionElement [] true,
|
||||
/// The `<th>` HTML element defines a cell as header of a group of table cells. The exact nature of this group is defined by the scope and headers attributes.
|
||||
|
||||
@@ -4,8 +4,8 @@ use crate::{
|
||||
renderer::{CastFrom, Rndr},
|
||||
ssr::StreamBuilder,
|
||||
view::{
|
||||
add_attr::AddAnyAttr, Mountable, Position, PositionState, Render,
|
||||
RenderHtml, ToTemplate,
|
||||
add_attr::AddAnyAttr, IntoRender, Mountable, Position, PositionState,
|
||||
Render, RenderHtml, ToTemplate,
|
||||
},
|
||||
};
|
||||
use const_str_slice_concat::{
|
||||
@@ -65,11 +65,13 @@ impl<E, At, Ch, NewChild> ElementChild<NewChild> for HtmlElement<E, At, Ch>
|
||||
where
|
||||
E: ElementWithChildren,
|
||||
Ch: Render + NextTuple,
|
||||
<Ch as NextTuple>::Output<NewChild>: Render,
|
||||
<Ch as NextTuple>::Output<NewChild::Output>: Render,
|
||||
|
||||
NewChild: Render,
|
||||
NewChild: IntoRender,
|
||||
NewChild::Output: Render,
|
||||
{
|
||||
type Output = HtmlElement<E, At, <Ch as NextTuple>::Output<NewChild>>;
|
||||
type Output =
|
||||
HtmlElement<E, At, <Ch as NextTuple>::Output<NewChild::Output>>;
|
||||
|
||||
fn child(self, child: NewChild) -> Self::Output {
|
||||
let HtmlElement {
|
||||
@@ -82,7 +84,7 @@ where
|
||||
tag,
|
||||
|
||||
attributes,
|
||||
children: children.next_tuple(child),
|
||||
children: children.next_tuple(child.into_render()),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -116,7 +118,7 @@ where
|
||||
/// Adds a child to the element.
|
||||
pub trait ElementChild<NewChild>
|
||||
where
|
||||
NewChild: Render,
|
||||
NewChild: IntoRender,
|
||||
{
|
||||
/// The type of the element, with the child added.
|
||||
type Output;
|
||||
|
||||
@@ -19,6 +19,7 @@ pub mod prelude {
|
||||
OnAttribute, OnTargetAttribute, PropAttribute,
|
||||
StyleAttribute,
|
||||
},
|
||||
IntoAttributeValue,
|
||||
},
|
||||
directive::DirectiveAttribute,
|
||||
element::{ElementChild, ElementExt, InnerHtmlAttribute},
|
||||
@@ -26,8 +27,8 @@ pub mod prelude {
|
||||
},
|
||||
renderer::{dom::Dom, Renderer},
|
||||
view::{
|
||||
add_attr::AddAnyAttr, any_view::IntoAny, Mountable, Render,
|
||||
RenderHtml,
|
||||
add_attr::AddAnyAttr, any_view::IntoAny, IntoRender, Mountable,
|
||||
Render, RenderHtml,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ macro_rules! svg_elements {
|
||||
($($tag:ident [$($attr:ty),*]),* $(,)?) => {
|
||||
paste::paste! {
|
||||
$(
|
||||
/// An SVG attribute.
|
||||
/// An SVG element.
|
||||
// `tag()` function
|
||||
#[allow(non_snake_case)]
|
||||
pub fn $tag() -> HtmlElement<[<$tag:camel>], (), ()>
|
||||
@@ -151,4 +151,33 @@ svg_elements![
|
||||
view [],
|
||||
];
|
||||
|
||||
// TODO <use>
|
||||
/// An SVG element.
|
||||
#[allow(non_snake_case)]
|
||||
pub fn r#use() -> HtmlElement<Use, (), ()>
|
||||
where {
|
||||
HtmlElement {
|
||||
tag: Use,
|
||||
attributes: (),
|
||||
children: (),
|
||||
}
|
||||
}
|
||||
|
||||
/// An SVG element.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct Use;
|
||||
|
||||
impl ElementType for Use {
|
||||
type Output = web_sys::SvgElement;
|
||||
|
||||
const TAG: &'static str = "use";
|
||||
const SELF_CLOSING: bool = false;
|
||||
const ESCAPE_CHILDREN: bool = true;
|
||||
const NAMESPACE: Option<&'static str> = Some("http://www.w3.org/2000/svg");
|
||||
|
||||
#[inline(always)]
|
||||
fn tag(&self) -> &str {
|
||||
Self::TAG
|
||||
}
|
||||
}
|
||||
|
||||
impl ElementWithChildren for Use {}
|
||||
|
||||
@@ -432,3 +432,23 @@ pub enum Position {
|
||||
/// This is the last child of its parent.
|
||||
LastChild,
|
||||
}
|
||||
|
||||
/// Declares that this type can be converted into some other type, which can be renderered.
|
||||
pub trait IntoRender {
|
||||
/// The renderable type into which this type can be converted.
|
||||
type Output;
|
||||
|
||||
/// Consumes this value, transforming it into the renderable type.
|
||||
fn into_render(self) -> Self::Output;
|
||||
}
|
||||
|
||||
impl<T> IntoRender for T
|
||||
where
|
||||
T: Render,
|
||||
{
|
||||
type Output = Self;
|
||||
|
||||
fn into_render(self) -> Self::Output {
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user