mirror/axum-htmx
1
0
Fork 0
mirror of https://github.com/robertwayne/axum-htmx synced 2024-11-27 13:44:55 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update doc comments

Browse source
This commit is contained in:
Rob Wagner 2024-06-24 18:12:19 -04:00
parent d36468f9d5
commit f4871d6e37
No known key found for this signature in database
GPG key ID: 53CCB4497B15CF61
2 changed files with 21 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/auto_vary.rs
View file

@ -29,8 +29,8 @@ const MIDDLEWARE_DOUBLE_USE: &str =
"Configuration error: `axum_httpx::vary_middleware` is used twice";
/// Addresses [htmx caching issue](https://htmx.org/docs/#caching)
/// by automatically adding a corresponding `Vary` header when [`HxRequest`], [`HxTarget`],
/// [`HxTrigger`], [`HxTriggerName`] or their combination is used.
/// by automatically adding a corresponding `Vary` header when [`HxRequest`],
/// [`HxTarget`], [`HxTrigger`], [`HxTriggerName`] or their combination is used.
#[derive(Clone)]
pub struct AutoVaryLayer;

33
src/responders/vary.rs
View file

@ -10,13 +10,15 @@ const HX_TRIGGER_NAME: HeaderValue = HeaderValue::from_static(headers::HX_TRIGGE
/// The `Vary: HX-Request` header.
///
/// You may want to add this header to the response if your handler responds differently based on
/// the `HX-Request` request header.
/// You may want to add this header to the response if your handler responds
/// differently based on the `HX-Request` request header.
///
/// For example, if your server renders the full HTML when the `HX-Request` header is missing or
/// `false`, and it renders a fragment of that HTML when `HX-Request: true`.
/// For example, if your server renders the full HTML when the `HX-Request`
/// header is missing or `false`, and it renders a fragment of that HTML when
/// `HX-Request: true`.
///
/// You probably need this only for `GET` requests, as other HTTP methods are not cached by default.
/// You probably need this only for `GET` requests, as other HTTP methods are
/// not cached by default.
///
/// See <https://htmx.org/docs/#caching> for more information.
#[derive(Debug, Clone)]
@ -41,10 +43,11 @@ impl extractors::HxRequest {
/// The `Vary: HX-Target` header.
///
/// You may want to add this header to the response if your handler responds differently based on
/// the `HX-Target` request header.
/// You may want to add this header to the response if your handler responds
/// differently based on the `HX-Target` request header.
///
/// You probably need this only for `GET` requests, as other HTTP methods are not cached by default.
/// You probably need this only for `GET` requests, as other HTTP methods are
/// not cached by default.
///
/// See <https://htmx.org/docs/#caching> for more information.
#[derive(Debug, Clone)]
@ -69,10 +72,11 @@ impl extractors::HxTarget {
/// The `Vary: HX-Trigger` header.
///
/// You may want to add this header to the response if your handler responds differently based on
/// the `HX-Trigger` request header.
/// You may want to add this header to the response if your handler responds
/// differently based on the `HX-Trigger` request header.
///
/// You probably need this only for `GET` requests, as other HTTP methods are not cached by default.
/// You probably need this only for `GET` requests, as other HTTP methods are
/// not cached by default.
///
/// See <https://htmx.org/docs/#caching> for more information.
#[derive(Debug, Clone)]
@ -97,10 +101,11 @@ impl extractors::HxTrigger {
/// The `Vary: HX-Trigger-Name` header.
///
/// You may want to add this header to the response if your handler responds differently based on
/// the `HX-Trigger-Name` request header.
/// You may want to add this header to the response if your handler responds
/// differently based on the `HX-Trigger-Name` request header.
///
/// You probably need this only for `GET` requests, as other HTTP methods are not cached by default.
/// You probably need this only for `GET` requests, as other HTTP methods are
/// not cached by default.
///
/// See <https://htmx.org/docs/#caching> for more information.
#[derive(Debug, Clone)]