htmxtools 0.1.4

A lightweight Rust crate for working with HTMX headers, specifically designed to integrate seamlessly with axum.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use std::{
    iter::once,
    ops::{Deref, DerefMut},
};

#[cfg(feature = "axum")]
use axum_core::response::{IntoResponse, IntoResponseParts, Response, ResponseParts};
#[cfg(feature = "axum")]
use axum_extra::TypedHeader;
use headers_core::{Error, Header};
use http::{HeaderName, HeaderValue};
use serde::Serialize;

use super::options::{Event, Events};

static HX_TRIGGER_AFTER_SWAP: HeaderName = HeaderName::from_static("hx-trigger-after-swap");

/// Allows you to trigger client-side events after the swap step.
pub struct HxTriggerAfterSwap<'a>(Events<'a>);

impl<'a> HxTriggerAfterSwap<'a> {
    /// Create a new `HxTriggerAfterSwap` with the given event name.
    pub fn event(name: &'a str) -> Self {
        let mut events = Events::with_capacity(1);
        events.push(Event::new(name));
        Self(events)
    }

    /// Create a new `HxTriggerAfterSwap` with the given event names.
    pub fn events(names: &[&'a str]) -> Self {
        let mut events = Events::with_capacity(names.len());
        for name in names {
            events.push(Event::new(name));
        }
        Self(events)
    }

    /// Create a new `HxTriggerAfterSwap` with the given event name and data.
    pub fn event_with_data<T>(name: &'a str, data: T) -> Result<Self, serde_json::Error>
    where
        T: Serialize,
    {
        let mut events = Events::with_capacity(1);
        events.push(Event::new_with_data(name, data)?);
        Ok(Self(events))
    }
}

impl<'a> Deref for HxTriggerAfterSwap<'a> {
    type Target = Events<'a>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl DerefMut for HxTriggerAfterSwap<'_> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<'a> From<Events<'a>> for HxTriggerAfterSwap<'a> {
    fn from(events: Events<'a>) -> Self {
        Self(events)
    }
}

#[cfg(feature = "axum")]
#[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
impl IntoResponseParts for HxTriggerAfterSwap<'_> {
    type Error = <TypedHeader<Self> as IntoResponseParts>::Error;

    fn into_response_parts(self, res: ResponseParts) -> Result<ResponseParts, Self::Error> {
        TypedHeader(self).into_response_parts(res)
    }
}

#[cfg(feature = "axum")]
#[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
impl IntoResponse for HxTriggerAfterSwap<'_> {
    fn into_response(self) -> Response {
        TypedHeader(self).into_response()
    }
}

impl Header for HxTriggerAfterSwap<'_> {
    fn name() -> &'static HeaderName {
        &HX_TRIGGER_AFTER_SWAP
    }

    fn decode<'i, I>(_: &mut I) -> Result<Self, Error>
    where
        Self: Sized,
        I: Iterator<Item = &'i HeaderValue>,
    {
        // This is a response header, so we don't need to decode it.
        Err(Error::invalid())
    }

    fn encode<E: Extend<HeaderValue>>(&self, values: &mut E) {
        let value = self
            .0
            .to_header_value()
            .expect("invalid value for HX-Trigger-After-Swap");

        values.extend(once(value));
    }
}