rune_core/item/
component_ref.rs

Help
1use core::fmt;
2
3use serde::{Deserialize, Serialize};
4
5#[cfg(feature = "alloc")]
6use crate::alloc;
7#[cfg(feature = "alloc")]
8use crate::item::Component;
9
10/// A reference to a component of an item.
11///
12/// All indexes refer to sibling indexes. So two sibling id components could
13/// have the indexes `1` and `2` respectively.
14#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
15pub enum ComponentRef<'a> {
16    /// A crate string component.
17    Crate(&'a str),
18    /// A regular string component.
19    Str(&'a str),
20    /// A nested anonymous part with an identifier.
21    Id(usize),
22}
23
24impl<'a> ComponentRef<'a> {
25    /// Get the component as a `&str` reference.
26    pub fn as_str(&self) -> Option<&'a str> {
27        match self {
28            ComponentRef::Str(string) => Some(string),
29            _ => None,
30        }
31    }
32
33    /// Get the identifier of the component if it is an identifier component.
34    pub fn id(self) -> Option<usize> {
35        match self {
36            Self::Id(n) => Some(n),
37            _ => None,
38        }
39    }
40
41    /// Coerce this [ComponentRef] into an owned [Component].
42    #[cfg(feature = "alloc")]
43    pub fn to_owned(&self) -> alloc::Result<Component> {
44        Ok(match *self {
45            ComponentRef::Crate(s) => Component::Crate(s.try_into()?),
46            ComponentRef::Str(s) => Component::Str(s.try_into()?),
47            ComponentRef::Id(id) => Component::Id(id),
48        })
49    }
50}
51
52impl fmt::Display for ComponentRef<'_> {
53    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
54        match self {
55            Self::Crate(s) => write!(fmt, "::{}", s),
56            Self::Str(s) => write!(fmt, "{}", s),
57            Self::Id(n) => write!(fmt, "${}", n),
58        }
59    }
60}
rune_core/item/component_ref.rs

rune_core/item/
component_ref.rs
