mirror/axum-htmx
1
0
Fork 0
mirror of https://github.com/robertwayne/axum-htmx synced 2024-12-27 02:39:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

Comment cleanup

Browse source
This commit is contained in:
Rob Wagner 2023-10-23 21:01:21 -04:00
parent d551c4cd8e
commit 22e81e0d0b
No known key found for this signature in database
GPG key ID: 53CCB4497B15CF61
2 changed files with 32 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/responders.rs
View file

@ -50,6 +50,8 @@ impl IntoResponseParts for HxLocation {
/// ///
/// Will fail if the supplied Uri contains characters that are not visible ASCII /// Will fail if the supplied Uri contains characters that are not visible ASCII
/// (32-127). /// (32-127).
///
/// See <https://htmx.org/headers/hx-push-url/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxPushUrl(pub Uri); pub struct HxPushUrl(pub Uri);
@ -118,6 +120,8 @@ impl IntoResponseParts for HxRefresh {
/// ///
/// Will fail if the supplied Uri contains characters that are not visible ASCII /// Will fail if the supplied Uri contains characters that are not visible ASCII
/// (32-127). /// (32-127).
///
/// See <https://htmx.org/headers/hx-replace-url/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxReplaceUrl(pub Uri); pub struct HxReplaceUrl(pub Uri);
@ -200,10 +204,14 @@ impl IntoResponseParts for HxReselect {
/// The `HX-Trigger` header. /// The `HX-Trigger` header.
/// ///
/// Allows you to trigger client-side events. /// Allows you to trigger client-side events. This only accepts events without
/// data attached. If you intend to add data to the event, you must enable the
/// `serde` feature flag.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxResponseTrigger(pub Vec<String>); pub struct HxResponseTrigger(pub Vec<String>);
@ -227,10 +235,14 @@ impl IntoResponseParts for HxResponseTrigger {
/// The `HX-Trigger-After-Settle` header. /// The `HX-Trigger-After-Settle` header.
/// ///
/// Allows you to trigger client-side events after the settle step. /// Allows you to trigger client-side events after the settle step. This only
/// accepts events without data attached. If you intend to add data to the
/// event, you must enable the `serde` feature flag.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxResponseTriggerAfterSettle(pub Vec<String>); pub struct HxResponseTriggerAfterSettle(pub Vec<String>);
@ -254,10 +266,14 @@ impl IntoResponseParts for HxResponseTriggerAfterSettle {
/// The `HX-Trigger-After-Swap` header. /// The `HX-Trigger-After-Swap` header.
/// ///
/// Allows you to trigger client-side events after the swap step. /// Allows you to trigger client-side events after the swap step. This only
/// accepts events without data attached. If you intend to add data to the
/// event, you must enable the `serde` feature flag.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxResponseTriggerAfterSwap(pub Vec<String>); pub struct HxResponseTriggerAfterSwap(pub Vec<String>);

13
src/responders/serde.rs
View file

@ -88,7 +88,9 @@ impl IntoResponseParts for HxLocation {
/// Allows you to trigger client-side events. /// Allows you to trigger client-side events.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxTrigger(pub Vec<HxEvent>); pub struct HxTrigger(pub Vec<HxEvent>);
@ -108,7 +110,9 @@ impl IntoResponseParts for HxTrigger {
/// Allows you to trigger client-side events after the settle step. /// Allows you to trigger client-side events after the settle step.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxTriggerAfterSettle(Vec<HxEvent>); pub struct HxTriggerAfterSettle(Vec<HxEvent>);
@ -130,7 +134,9 @@ impl IntoResponseParts for HxTriggerAfterSettle {
/// Allows you to trigger client-side events after the swap step. /// Allows you to trigger client-side events after the swap step.
/// ///
/// Will fail if the supplied events contain or produce characters that are not /// Will fail if the supplied events contain or produce characters that are not
/// visible ASCII (32-127) when serializing to json. /// visible ASCII (32-127) when serializing to JSON.
///
/// See <https://htmx.org/headers/hx-trigger/> for more information.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct HxTriggerAfterSwap(Vec<HxEvent>); pub struct HxTriggerAfterSwap(Vec<HxEvent>);
@ -157,6 +163,7 @@ impl HxEvent {
pub fn new<T: Serialize>(name: String) -> Self { pub fn new<T: Serialize>(name: String) -> Self {
Self { name, data: None } Self { name, data: None }
} }
pub fn new_with_data<T: Serialize>(name: String, data: T) -> Result<Self, serde_json::Error> { pub fn new_with_data<T: Serialize>(name: String, data: T) -> Result<Self, serde_json::Error> {
let data = serde_json::to_value(data)?; let data = serde_json::to_value(data)?;