apub-core 0.2.0

Utilities for building activitypub servers
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

//! A provided ObjectId type

use std::{
    borrow::Cow,
    fmt::Display,
    marker::PhantomData,
    ops::{Deref, DerefMut},
};
use url::Url;

/// A type generic over a `Kind` but contains only an internal Url
///
/// This type likely shouldn't be used directly, but is a helper for building your own ObjectId
/// type.
///
/// ```rust
/// use apub_core::repo::Dereference;
/// use url::Url;
///
/// #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
/// #[serde(transparent)]
/// pub struct ObjectId<Kind>(apub_core::object_id::ObjectId<'static, Kind>);
///
/// pub fn object_id<Kind>(url: Url) -> ObjectId<Kind> {
///     ObjectId(apub_core::object_id::ObjectId::new_owned(url))
/// }
///
/// #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
/// struct MyKind;
/// #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
/// struct MyObject {
///     id: ObjectId<MyKind>,
/// }
///
/// impl Dereference for ObjectId<MyKind> {
///     type Output = MyObject;
///
///     fn url(&self) -> &Url {
///         &self.0
///     }
/// }
/// ```
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ObjectId<'a, Kind> {
    url: Cow<'a, Url>,
    _kind: PhantomData<fn() -> Kind>,
}

impl<'a, Kind> Clone for ObjectId<'a, Kind> {
    fn clone(&self) -> Self {
        Self {
            url: self.url.clone(),
            _kind: PhantomData,
        }
    }
}

impl<Kind> ObjectId<'static, Kind> {
    /// Create a new owned ObjectId
    pub fn new_owned(url: Url) -> Self {
        Self {
            url: Cow::Owned(url),
            _kind: PhantomData,
        }
    }
}

impl<'a, Kind> ObjectId<'a, Kind> {
    /// Create a new borrowed ObjectId
    ///
    /// This is useful for creating a valid Dereference type from a borrowed Url without cloning
    pub fn new_borrowed(url: &'a Url) -> Self {
        Self {
            url: Cow::Borrowed(url),
            _kind: PhantomData,
        }
    }
}

impl<'a, Kind> Deref for ObjectId<'a, Kind> {
    type Target = Url;

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

impl<'a, Kind> DerefMut for ObjectId<'a, Kind> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.url.to_mut()
    }
}

impl<'a, Kind> Display for ObjectId<'a, Kind> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.url.fmt(f)
    }
}

impl<'a, Kind> serde::ser::Serialize for ObjectId<'a, Kind> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        self.url.serialize(serializer)
    }
}

impl<'de, Kind> serde::de::Deserialize<'de> for ObjectId<'static, Kind> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        Url::deserialize(deserializer).map(ObjectId::new_owned)
    }
}