url-cleaner-engine 0.11.0

The engine behind URL Cleaner.
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
110
111
112
113
114
115
116
117
118

//! Macros.

#[expect(unused_imports, reason = "Used in a doc comment.")]
use std::str::FromStr;
#[expect(unused_imports, reason = "Used in a doc comment.")]
use std::borrow::Cow;
#[expect(unused_imports, reason = "Used in doc comments.")]
use crate::types::*;

/// Helper macro to make serde use [`FromStr`] to deserialize strings.
///
/// See [serde_with#702](https://github.com/jonasbb/serde_with/issues/702#issuecomment-1951348210) for details.
macro_rules! string_or_struct_magic {
    ($type:ty) => {
        impl Serialize for $type {
            fn serialize<S: serde::ser::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
                <$type>::serialize(self, serializer)
            }
        }
        impl<'de> Deserialize<'de> for $type {
            fn deserialize<D: serde::de::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
                struct V;

                impl<'de> serde::de::Visitor<'de> for V {
                    type Value = $type;

                    fn expecting(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
                        f.write_str("Expected a string or a map.")
                    }

                    fn visit_str<E: serde::de::Error>(self, s: &str) -> Result<Self::Value, E> {
                        Self::Value::from_str(s).map_err(E::custom)
                    }

                    fn visit_map<M: serde::de::MapAccess<'de>>(self, map: M) -> Result<Self::Value, M::Error> {
                        Self::Value::deserialize(serde::de::value::MapAccessDeserializer::new(map))
                    }
                }

                deserializer.deserialize_any(V)
            }
        }
    }
}

/// Helper macro to get a [`StringSource`]'s value as an [`Option`] of a [`String`].
macro_rules! get_option_string {
    ($value:expr, $task_state:expr) => {
        get_option_cow!($value, $task_state).map(std::borrow::Cow::into_owned)
    }
}

/// Helper macro to get a [`StringSource`]'s value as an [`Option`] of a [`str`].
macro_rules! get_option_str {
    ($value:expr, $task_state:expr) => {
        get_option_cow!($value, $task_state).as_deref()
    }
}

/// Helper macro to get a [`StringSource`]'s value as an [`Option`] of a [`str`].
macro_rules! get_new_option_str {
    ($value:expr, $task_state:expr) => {
        get_option_string!($value, $task_state).as_deref()
    }
}

/// Helper macro to get a [`StringSource`]'s value as an [`Option`] of a [`Cow`].
macro_rules! get_option_cow {
    ($value:expr, $task_state:expr) => {
        match $value {
            StringSource::String(value) => Some(std::borrow::Cow::Borrowed(value.as_str())),
            StringSource::None => None,
            value => value.get(&$task_state.to_view())?
        }
    }
}

/// Helper macro to get a [`StringSource`]'s value as a [`String`] or return an error if it's [`None`].
macro_rules! get_string {
    ($value:expr, $task_state:expr, $error:ty) => {
        get_cow!($value, $task_state, $error).into_owned()
    }
}

/// Helper macro to get a [`StringSource`]'s value as a [`str`] or return an error if it's [`None`].
macro_rules! get_str {
    ($value:expr, $task_state:expr, $error:ty) => {
        &*get_cow!($value, $task_state, $error)
    }
}

/// Helper macro to get a [`StringSource`]'s value as a [`str`] or return an error if it's [`None`].
macro_rules! get_new_str {
    ($value:expr, $task_state:expr, $error:ty) => {
        &*get_string!($value, $task_state, $error)
    }
}

/// Helper macro to get a [`StringSource`]'s value as a [`Cow`] or return an error if it's [`None`].
macro_rules! get_cow {
    ($value:expr, $task_state:expr, $error:ty) => {
        match $value.get_self() {
            StringSource::String(value) => std::borrow::Cow::Borrowed(value.as_str()),
            value => value.get(&$task_state.to_view())?.ok_or(<$error>::StringSourceIsNone)?
        }
    }
}

pub(crate) use string_or_struct_magic;
pub(crate) use get_str;
pub(crate) use get_new_str;
pub(crate) use get_string;
pub(crate) use get_cow;
pub(crate) use get_option_str;
pub(crate) use get_new_option_str;
pub(crate) use get_option_string;
pub(crate) use get_option_cow;
pub(crate) use url_cleaner_macros::edoc;