Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Pitasi/rscx
Rust Server Components. JSX-like syntax and async out of the box.
https://github.com/Pitasi/rscx
hacktoberfest rscx rust web
Last synced: 3 months ago
JSON representation
Rust Server Components. JSX-like syntax and async out of the box.
- Host: GitHub
- URL: https://github.com/Pitasi/rscx
- Owner: Pitasi
- License: mit
- Created: 2023-09-06T12:57:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-15T20:46:04.000Z (11 months ago)
- Last Synced: 2024-10-05T12:04:09.444Z (4 months ago)
- Topics: hacktoberfest, rscx, rust, web
- Language: Rust
- Homepage: https://rscx.dev/
- Size: 69.3 KB
- Stars: 63
- Watchers: 2
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RSCx - Rust Server Components
RSCx is a server-side HTML rendering engine library with a neat developer
experience and great performance.
Features:
- all components are async functions
- JSX-like syntax called RSX parsed with [rstml](https://github.com/rs-tml/rstml)
- contexts, to easily pass values down the components tree ([example](https://github.com/Pitasi/rscx/blob/main/rscx/examples/context.rs))
- inspired by [Maud](https://maud.lambda.xyz/) and [Leptos](https://leptos.dev/)
*⚠️ Warning: not production-ready yet. It lacks important features such as HTML
escaping!*
## Usage
All the examples can be found in [rscx/examples/](https://github.com/Pitasi/rscx/tree/main/rscx/examples).
```rs
use rscx::{component, html, props, CollectFragment};
#[tokio::main]
async fn main() -> Result<(), Box> {
let app = app().await;
println!("{}", app);
Ok(())
}
// simple function returning a String
// it will call the Items() function
async fn app() -> String {
let s = "ul { color: red; }";
html! {
{s}
// call a component with no props
// call a component with props and children
}
}
#[component]
/// mark functions with #[component] to use them as components inside html! macro
fn Section(
// you can use `builder` attributes to specify a default value (makes this prop optional)
#[builder(default = "Default title".into(), setter(into))] title: String,
#[builder(default)] children: String,
) -> String {
html! {
{ title }
{ children }
}
}
#[component]
async fn Items() -> String {
let data = load_data_async().await;
html! {
- { item } })
{
data
.into_iter()
.map(|item| html! {
.collect_fragment() // helper method to collect a list of components into a String
}
}
}
/// async functions can be easily used in the body of a component, as every component is an async
/// function
async fn load_data_async() -> Vec {
vec!["a".to_string(), "b".to_string(), "c".to_string()]
}
```
## Benchmarks
RSCx is fast.
*Disclaimer*: RSCx is for servers, as the name suggests. Therefore the following
comparisons with Leptos are unfair. This library contains only a fraction of
Leptos' features.
*Disclaimer 2*: The benchmarks are pretty basics and should not influence your
decision on whether to use or not this library. Focus on the DX. They are
included as I kept running them to make sure I didn't fall too much behind
alternatives.
The time in the middle of the three is the average.
### Run the benchmarks locally
```
cd bench
# cargo install criterion
cargo criterion
```
### Benchmark 1: single element, lots of HTML attributes
```
many_attrs/maud_many_attrs
time: [205.89 ns 208.35 ns 211.53 ns]
many_attrs/horrorshow_many_attrs
time: [37.221 µs 37.304 µs 37.401 µs]
many_attrs/html_node_many_attrs
time: [67.726 µs 67.830 µs 67.939 µs]
many_attrs/leptos_many_attrs
time: [923.31 ns 928.46 ns 935.04 ns]
many_attrs/rscx_many_attrs
time: [207.96 ns 212.82 ns 219.28 ns]
```
RSCx and Maud pretty much are the same as their macros output is effectively a
static string with the result.
### Benchmark 2: little element with props and child
```
small_fragment/maud_small_fragment
time: [107.60 ns 107.71 ns 107.81 ns]
small_fragment/horrorshow_small_fragment
time: [405.98 ns 406.08 ns 406.21 ns]
small_fragment/leptos_small_fragment
time: [1.7641 µs 1.7652 µs 1.7662 µs]
small_fragment/rscx_small_fragment
time: [101.79 ns 101.87 ns 101.97 ns]
```
RSCx offers a better DX than Maud, as the syntax is nicer and values such as i32
can be passed as props/attributes, while in Maud every attribute must be a
static string.
### Benchmark 3: dynamic attributes (read for variable)
```
many_dyn_attrs/horrorshow_many_dyn_attrs
time: [50.445 µs 50.702 µs 50.977 µs]
many_dyn_attrs/leptos_many_dyn_attrs
time: [100.13 µs 100.52 µs 101.00 µs]
many_dyn_attrs/rscx_many_dyn_attrs
time: [33.953 µs 33.990 µs 34.037 µs]
```
### Benchmark 4: async component rendering a list of 100 items
```
async_list/maud_async_list
time: [2.3114 µs 2.3241 µs 2.3377 µs]
async_list/leptos_async_list
time: [55.149 µs 55.228 µs 55.315 µs]
async_list/rscx_async_list
time: [5.4809 µs 5.4987 µs 5.5151 µs]
```
I'll reiterate the disclaimer: Leptos is not specifically made for SSR. Going
through its reactivity system (using async resources) adds overhead.