feat: docs
This commit is contained in:
parent
a335490717
commit
5696c4e346
3 changed files with 9 additions and 0 deletions
|
@ -2,6 +2,12 @@
|
||||||
name = "leptos_reactive_axum_macros"
|
name = "leptos_reactive_axum_macros"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
description = "reactive context for axum handlers"
|
||||||
|
authors = ["davidontop <me@davidon.top>"]
|
||||||
|
readme = "../README.md"
|
||||||
|
documentation = "https://docs.rs/leptos_reactive_axum_macros"
|
||||||
|
license = "MIT"
|
||||||
|
repository = "https://git.davidon.top/public/leptos_reactive_axum.git"
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
proc-macro = true
|
proc-macro = true
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
mod reactive;
|
mod reactive;
|
||||||
|
|
||||||
|
/// macro that when applied on an axum handler will provide leptos_reactive runtime and will allow you to use `leptos_reactive_axum::extract` by providing a context holding request parts
|
||||||
#[proc_macro_attribute]
|
#[proc_macro_attribute]
|
||||||
pub fn reactive(
|
pub fn reactive(
|
||||||
attr: proc_macro::TokenStream,
|
attr: proc_macro::TokenStream,
|
||||||
|
|
|
@ -6,6 +6,7 @@ use axum::{extract::FromRequestParts, http::request::Parts};
|
||||||
use error::ExtractionError;
|
use error::ExtractionError;
|
||||||
pub use leptos_reactive_axum_macros::reactive;
|
pub use leptos_reactive_axum_macros::reactive;
|
||||||
|
|
||||||
|
/// used to extract request parts from handlers, should be used in conjunction with `leptos_reactive_axum_macros::reactive macro`
|
||||||
pub async fn extract<T>() -> Result<T, ExtractionError>
|
pub async fn extract<T>() -> Result<T, ExtractionError>
|
||||||
where
|
where
|
||||||
T: FromRequestParts<()>,
|
T: FromRequestParts<()>,
|
||||||
|
@ -14,6 +15,7 @@ where
|
||||||
extract_with_state::<T, ()>(&()).await
|
extract_with_state::<T, ()>(&()).await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// used to extract request parts from handlers with state, should be used in conjunction with `leptos_reactive_axum_macros::reactive macro`
|
||||||
pub async fn extract_with_state<T, S>(state: &S) -> Result<T, ExtractionError>
|
pub async fn extract_with_state<T, S>(state: &S) -> Result<T, ExtractionError>
|
||||||
where
|
where
|
||||||
T: FromRequestParts<S>,
|
T: FromRequestParts<S>,
|
||||||
|
|
Loading…
Reference in a new issue