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

use std::iter::once;

#[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, Uri};

use crate::util::{iter::IterExt, uri::UriExt};

const FALSE: HeaderValue = HeaderValue::from_static("false");

static HX_PUSH_URL: HeaderName = HeaderName::from_static("hx-push-url");

/// Pushes a new url into the history stack.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct HxPushUrl(HxPushUrlValue);

impl HxPushUrl {
    /// Prevents the browser’s history from being updated.
    pub const fn prevent() -> Self {
        Self(HxPushUrlValue::Prevent)
    }

    /// A URL to be pushed into the location bar. This may be relative or absolute, as per
    /// [`history.pushState()`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState).
    pub fn url(uri: Uri) -> Self {
        Self(HxPushUrlValue::Url(uri))
    }

    /// Get the value of the `HxPushUrl`. If `None`, the browser’s history will not be updated.
    pub fn get(&self) -> Option<&Uri> {
        match &self.0 {
            HxPushUrlValue::Prevent => None,
            HxPushUrlValue::Url(uri) => Some(uri),
        }
    }

    fn from_header_value(value: &HeaderValue) -> Result<Self, Error> {
        if value == FALSE {
            Ok(Self(HxPushUrlValue::Prevent))
        } else {
            let uri = value.to_uri()?;
            Ok(Self(HxPushUrlValue::Url(uri)))
        }
    }

    fn to_header_value(&self) -> Option<HeaderValue> {
        match &self.0 {
            HxPushUrlValue::Prevent => Some(FALSE.clone()),
            HxPushUrlValue::Url(uri) => HeaderValue::from_uri(uri),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
enum HxPushUrlValue {
    Prevent,
    Url(Uri),
}

#[cfg(feature = "axum")]
#[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
impl IntoResponseParts for HxPushUrl {
    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 HxPushUrl {
    fn into_response(self) -> Response {
        TypedHeader(self).into_response()
    }
}

impl Header for HxPushUrl {
    fn name() -> &'static HeaderName {
        &HX_PUSH_URL
    }

    fn decode<'i, I>(values: &mut I) -> Result<Self, Error>
    where
        Self: Sized,
        I: Iterator<Item = &'i HeaderValue>,
    {
        let value = values.just_one().ok_or_else(Error::invalid)?;
        Self::from_header_value(value)
    }

    fn encode<E: Extend<HeaderValue>>(&self, values: &mut E) {
        values.extend(once(
            self.to_header_value()
                .expect("invalid value for HX-Push-URL"),
        ));
    }
}