adam/leptos-use
1
0
Fork 0
mirror of https://github.com/adoyle0/leptos-use.git synced 2025-02-02 10:54:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

added function header and made use_cookie use it

Browse source
This commit is contained in:
Maccesch 2024-07-28 17:41:16 +01:00
parent c64fb046f8
commit 4ec66ecbc8
7 changed files with 138 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -3,6 +3,12 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### New Functions 🚀
- `header` – Standard implementations for reading a header on the server.
## [0.11.0] - 2024-07-27
### New Functions 🚀

1
docs/book/src/SUMMARY.md
View file

@ -99,6 +99,7 @@
# Utilities
- [header](utilities/header.md)
- [is_err](utilities/is_err.md)
- [is_none](utilities/is_none.md)
- [is_ok](utilities/is_ok.md)

3
docs/book/src/utilities/header.md Normal file
View file

@ -0,0 +1,3 @@
# header
<!-- cmdrun python3 ../extract_doc_comment.py utils/header -->

74
src/use_cookie.rs
View file

@ -1,6 +1,7 @@
#![allow(clippy::too_many_arguments)]
use crate::core::now;
use crate::utils::get_header;
use codee::{CodecError, Decoder, Encoder};
use cookie::time::{Duration, OffsetDateTime};
pub use cookie::SameSite;
@ -496,78 +497,7 @@ impl<T, E, D> Default for UseCookieOptions<T, E, D> {
path: None,
same_site: None,
ssr_cookies_header_getter: Rc::new(move || {
#[cfg(feature = "ssr")]
{
#[cfg(all(feature = "actix", feature = "axum"))]
compile_error!("You can only enable one of features \"actix\" and \"axum\" at the same time");
#[cfg(all(feature = "actix", feature = "spin"))]
compile_error!("You can only enable one of features \"actix\" and \"spin\" at the same time");
#[cfg(all(feature = "axum", feature = "spin"))]
compile_error!("You can only enable one of features \"axum\" and \"spin\" at the same time");
#[cfg(feature = "actix")]
const COOKIE: http0_2::HeaderName = http0_2::header::COOKIE;
#[cfg(any(feature = "axum", feature = "spin"))]
const COOKIE: http1::HeaderName = http1::header::COOKIE;
#[cfg(feature = "actix")]
type HeaderValue = http0_2::HeaderValue;
#[cfg(feature = "axum")]
type HeaderValue = http1::HeaderValue;
#[cfg(any(feature = "axum", feature = "actix", feature = "spin"))]
let headers;
#[cfg(feature = "actix")]
{
headers = use_context::<actix_web::HttpRequest>()
.map(|req| req.headers().clone());
}
#[cfg(feature = "axum")]
{
headers = use_context::<http1::request::Parts>().map(|parts| parts.headers);
}
#[cfg(feature = "spin")]
{
headers = use_context::<leptos_spin::RequestParts>()
.map(|parts| parts.headers().clone());
}
#[cfg(all(
not(feature = "axum"),
not(feature = "actix"),
not(feature = "spin")
))]
{
leptos::logging::warn!("If you're using use_cookie without the feature `axum`, `actix` or `spin` enabled, you should provide the option `ssr_cookies_header_getter`");
None
}
#[cfg(any(feature = "axum", feature = "actix"))]
{
headers.map(|headers| {
headers
.get(COOKIE)
.cloned()
.unwrap_or_else(|| HeaderValue::from_static(""))
.to_str()
.unwrap_or_default()
.to_owned()
})
}
#[cfg(feature = "spin")]
{
headers.and_then(|headers| {
headers
.iter()
.find(|(key, _)| **key == COOKIE)
.and_then(|(_, value)| String::from_utf8(value.to_vec()).ok())
})
}
}
#[cfg(not(feature = "ssr"))]
None
get_header!(COOKIE, use_cookie, ssr_cookies_header_getter)
}),
ssr_set_cookie: Rc::new(|cookie: &Cookie| {
#[cfg(feature = "ssr")]

76
src/utils/header.rs Normal file
View file

@ -0,0 +1,76 @@
#[cfg(feature = "actix")]
use http0_2::HeaderName;
#[cfg(any(feature = "axum", feature = "spin"))]
use http1::HeaderName;
use leptos::*;
/// Get the value of the header with the given name.
///
/// This function is only meant to be used on the server.
/// So it is only defined when the feature `"ssr"` is enabled together with one of the
/// features `"axum"`, `"actix"` or `"spin"`.
///
/// ## Example
///
/// ```ignore
/// # use leptos_use::utils::header;
/// #
/// let content_len = header(http::header::CONTENT_LENGTH);
/// ```
pub fn header<N>(name: N) -> Option<String>
where
N: Into<HeaderName>,
{
let name = name.into();
#[cfg(all(feature = "actix", feature = "axum"))]
compile_error!("You can only enable one of features \"actix\" and \"axum\" at the same time");
#[cfg(all(feature = "actix", feature = "spin"))]
compile_error!("You can only enable one of features \"actix\" and \"spin\" at the same time");
#[cfg(all(feature = "axum", feature = "spin"))]
compile_error!("You can only enable one of features \"axum\" and \"spin\" at the same time");
#[cfg(feature = "actix")]
type HeaderValue = http0_2::HeaderValue;
#[cfg(feature = "axum")]
type HeaderValue = http1::HeaderValue;
#[cfg(any(feature = "axum", feature = "actix", feature = "spin"))]
let headers;
#[cfg(feature = "actix")]
{
headers = use_context::<actix_web::HttpRequest>().map(|req| req.headers().clone());
}
#[cfg(feature = "axum")]
{
headers = use_context::<http1::request::Parts>().map(|parts| parts.headers);
}
#[cfg(feature = "spin")]
{
headers = use_context::<leptos_spin::RequestParts>().map(|parts| parts.headers().clone());
}
#[cfg(any(feature = "axum", feature = "actix"))]
{
headers.map(|headers| {
headers
.get(name)
.cloned()
.unwrap_or_else(|| HeaderValue::from_static(""))
.to_str()
.unwrap_or_default()
.to_owned()
})
}
#[cfg(feature = "spin")]
{
headers.and_then(|headers| {
headers
.iter()
.find(|(key, _)| **key == name)
.and_then(|(_, value)| String::from_utf8(value.to_vec()).ok())
})
}
}

36
src/utils/header_macro.rs Normal file
View file

@ -0,0 +1,36 @@
macro_rules! get_header {
(
$header_name:ident,
$function_name:ident,
$option_name:ident
$(,)?
) => {
if cfg!(feature = "ssr") {
#[cfg(all(
not(feature = "axum"),
not(feature = "actix"),
not(feature = "spin")
))]
{
leptos::logging::warn!(
"If you're using `{}` with SSR but without any of the features `axum`, `actix` or `spin` enabled, you have to provide the option `{}`",
stringify!($function_name),
stringify!($option_name)
);
return None;
}
#[cfg(feature = "actix")]
const $header_name: http0_2::HeaderName = http0_2::header::$header_name;
#[cfg(any(feature = "axum", feature = "spin"))]
const $header_name: http1::HeaderName = http1::header::$header_name;
#[cfg(any(feature = "axum", feature = "actix", feature = "spin"))]
crate::utils::header($header_name)
} else {
None
}
};
}
pub(crate) use get_header;

12
src/utils/mod.rs
View file

@ -1,4 +1,10 @@
mod filters;
#[cfg(all(
feature = "ssr",
any(feature = "axum", feature = "actix", feature = "spin")
))]
mod header;
mod header_macro;
mod is;
mod js;
mod js_value_from_to_string;
@ -7,6 +13,12 @@ mod signal_filtered;
mod use_derive_signal;
pub use filters::*;
#[cfg(all(
feature = "ssr",
any(feature = "axum", feature = "actix", feature = "spin")
))]
pub use header::*;
pub(crate) use header_macro::*;
pub use is::*;
pub(crate) use js_value_from_to_string::*;
pub use pausable::*;