cbf-chrome 0.1.0-alpha.4

Chromium-specific safe API layer for CBF.
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

//! Chrome-facing stable identifiers; primarily `TabId` as the Chromium-layer counterpart of `BrowsingContextId`.

use cbf::data::ids::{BrowsingContextId, TransientBrowsingContextId};

/// Chrome-facing stable identifier for a tab managed by Chromium runtime.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct TabId(pub u64);

/// Chrome-facing stable identifier for an extension popup.
///
/// This is the current Chromium-side carrier for generic
/// `TransientBrowsingContextId` values.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PopupId(pub u64);

impl std::fmt::Display for TabId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.get())
    }
}

impl TabId {
    /// Create a new identifier from a raw numeric value.
    pub const fn new(raw: u64) -> Self {
        Self(raw)
    }

    /// Get the raw numeric value of this identifier.
    pub const fn get(self) -> u64 {
        self.0
    }

    /// Convert from generic-layer browsing context ID.
    pub const fn from_browsing_context_id(id: BrowsingContextId) -> Self {
        Self(id.get())
    }

    /// Convert into generic-layer browsing context ID.
    pub const fn to_browsing_context_id(self) -> BrowsingContextId {
        BrowsingContextId::new(self.get())
    }
}

impl PopupId {
    /// Create a new identifier from a raw numeric value.
    pub const fn new(raw: u64) -> Self {
        Self(raw)
    }

    /// Get the raw numeric value of this identifier.
    pub const fn get(self) -> u64 {
        self.0
    }

    /// Convert from generic-layer transient browsing context ID.
    pub const fn from_transient_browsing_context_id(id: TransientBrowsingContextId) -> Self {
        Self(id.get())
    }

    /// Convert into generic-layer transient browsing context ID.
    pub const fn to_transient_browsing_context_id(self) -> TransientBrowsingContextId {
        TransientBrowsingContextId::new(self.get())
    }
}

impl From<BrowsingContextId> for TabId {
    fn from(value: BrowsingContextId) -> Self {
        Self::from_browsing_context_id(value)
    }
}

impl From<TabId> for BrowsingContextId {
    fn from(value: TabId) -> Self {
        value.to_browsing_context_id()
    }
}

impl From<TransientBrowsingContextId> for PopupId {
    fn from(value: TransientBrowsingContextId) -> Self {
        Self::from_transient_browsing_context_id(value)
    }
}

impl From<PopupId> for TransientBrowsingContextId {
    fn from(value: PopupId) -> Self {
        value.to_transient_browsing_context_id()
    }
}

#[cfg(test)]
mod tests {
    use cbf::data::ids::{BrowsingContextId, TransientBrowsingContextId};

    use super::{PopupId, TabId};

    #[test]
    fn tab_id_round_trip_preserves_raw_value() {
        let original = BrowsingContextId::new(4242);

        let tab_id = TabId::from(original);
        let round_trip = tab_id.to_browsing_context_id();

        assert_eq!(round_trip, BrowsingContextId::new(4242));
        assert_eq!(tab_id, TabId::new(4242));
    }

    #[test]
    fn popup_id_round_trip_preserves_raw_value() {
        let original = TransientBrowsingContextId::new(77);

        let popup_id = PopupId::from(original);
        let round_trip = popup_id.to_transient_browsing_context_id();

        assert_eq!(round_trip, TransientBrowsingContextId::new(77));
        assert_eq!(popup_id, PopupId::new(77));
    }
}