moniker/
extended_moniker.rs

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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use crate::error::MonikerError;
use crate::moniker::Moniker;
use core::cmp::Ord;
use std::fmt;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// One of:
/// - A moniker
/// - A marker representing component manager's realm
#[cfg_attr(feature = "serde", derive(Deserialize, Serialize), serde(rename_all = "snake_case"))]
#[derive(Eq, Ord, PartialOrd, PartialEq, Debug, Clone, Hash)]
pub enum ExtendedMoniker {
    ComponentInstance(Moniker),
    ComponentManager,
}

/// The string representation of ExtendedMoniker::ComponentManager
pub const EXTENDED_MONIKER_COMPONENT_MANAGER_STR: &'static str = "<component_manager>";

impl ExtendedMoniker {
    pub fn unwrap_instance_moniker_or<E: std::error::Error>(
        &self,
        error: E,
    ) -> Result<&Moniker, E> {
        match self {
            Self::ComponentManager => Err(error),
            Self::ComponentInstance(moniker) => Ok(moniker),
        }
    }

    pub fn has_prefix(&self, other: &Self) -> bool {
        match (self, other) {
            (_, Self::ComponentManager) => true,
            (Self::ComponentManager, Self::ComponentInstance(_)) => false,
            (Self::ComponentInstance(a), Self::ComponentInstance(b)) => a.has_prefix(b),
        }
    }

    pub fn parse_str(rep: &str) -> Result<Self, MonikerError> {
        if rep == EXTENDED_MONIKER_COMPONENT_MANAGER_STR {
            Ok(ExtendedMoniker::ComponentManager)
        } else {
            Ok(ExtendedMoniker::ComponentInstance(Moniker::parse_str(rep)?))
        }
    }
}

impl TryFrom<&str> for ExtendedMoniker {
    type Error = MonikerError;

    fn try_from(input: &str) -> Result<Self, MonikerError> {
        Self::parse_str(input)
    }
}

impl std::str::FromStr for ExtendedMoniker {
    type Err = MonikerError;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Self::parse_str(s)
    }
}

impl fmt::Display for ExtendedMoniker {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ComponentInstance(m) => {
                write!(f, "{}", m)?;
            }
            Self::ComponentManager => {
                write!(f, "{}", EXTENDED_MONIKER_COMPONENT_MANAGER_STR)?;
            }
        }
        Ok(())
    }
}

impl From<Moniker> for ExtendedMoniker {
    fn from(m: Moniker) -> Self {
        Self::ComponentInstance(m)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse() {
        assert_eq!(
            ExtendedMoniker::parse_str(EXTENDED_MONIKER_COMPONENT_MANAGER_STR).unwrap(),
            ExtendedMoniker::ComponentManager
        );
        assert_eq!(
            ExtendedMoniker::parse_str("/foo/bar").unwrap(),
            ExtendedMoniker::ComponentInstance(Moniker::parse_str("/foo/bar").unwrap())
        );
        assert!(ExtendedMoniker::parse_str("").is_err(), "cannot be empty");
    }

    #[test]
    fn has_prefix() {
        let cm = ExtendedMoniker::ComponentManager;
        let root = ExtendedMoniker::ComponentInstance(Moniker::root());
        let a = ExtendedMoniker::ComponentInstance(Moniker::parse_str("a").unwrap());
        let ab = ExtendedMoniker::ComponentInstance(Moniker::parse_str("a/b").unwrap());

        assert!(cm.has_prefix(&cm));
        assert!(!cm.has_prefix(&root));
        assert!(!cm.has_prefix(&a));
        assert!(!cm.has_prefix(&ab));

        assert!(root.has_prefix(&cm));
        assert!(root.has_prefix(&root));
        assert!(!root.has_prefix(&a));
        assert!(!root.has_prefix(&ab));

        assert!(a.has_prefix(&cm));
        assert!(a.has_prefix(&root));
        assert!(a.has_prefix(&a));
        assert!(!a.has_prefix(&ab));

        assert!(ab.has_prefix(&cm));
        assert!(ab.has_prefix(&root));
        assert!(ab.has_prefix(&a));
        assert!(ab.has_prefix(&ab));
    }

    #[test]
    fn to_string_functions() {
        let cm_moniker =
            ExtendedMoniker::parse_str(EXTENDED_MONIKER_COMPONENT_MANAGER_STR).unwrap();
        let foobar_moniker = ExtendedMoniker::parse_str("foo/bar").unwrap();
        let empty_moniker = ExtendedMoniker::parse_str(".").unwrap();

        assert_eq!(format!("{}", cm_moniker), EXTENDED_MONIKER_COMPONENT_MANAGER_STR.to_string());
        assert_eq!(cm_moniker.to_string(), EXTENDED_MONIKER_COMPONENT_MANAGER_STR.to_string());
        assert_eq!(format!("{}", foobar_moniker), "foo/bar".to_string());
        assert_eq!(foobar_moniker.to_string(), "foo/bar".to_string());
        assert_eq!(format!("{}", empty_moniker), ".".to_string());
        assert_eq!(empty_moniker.to_string(), ".".to_string());
    }
}