mezzaluna_loaded_features/feature/
mod.rs

1use std::path::{Path, PathBuf};
2
3#[cfg(feature = "disk")]
4use same_file::Handle;
5
6#[cfg(feature = "disk")]
7mod disk;
8mod memory;
9
10#[derive(Debug, Hash, PartialEq, Eq)]
11enum FeatureType {
12    #[cfg(feature = "disk")]
13    Disk(disk::Feature),
14    Memory(memory::Feature),
15}
16
17impl FeatureType {
18    #[must_use]
19    #[cfg(feature = "disk")]
20    pub fn with_handle_and_path(handle: Handle, path: PathBuf) -> Self {
21        let inner = disk::Feature::with_handle_and_path(handle, path);
22        Self::Disk(inner)
23    }
24
25    #[must_use]
26    pub fn with_in_memory_path(path: PathBuf) -> Self {
27        let inner = memory::Feature::with_path(path);
28        Self::Memory(inner)
29    }
30
31    #[must_use]
32    pub fn path(&self) -> &Path {
33        match self {
34            #[cfg(feature = "disk")]
35            Self::Disk(inner) => inner.path(),
36            Self::Memory(inner) => inner.path(),
37        }
38    }
39}
40
41/// A Ruby source ("feature") that has been loaded into an interpreter.
42///
43/// Features can either be loaded from disk or from memory.
44///
45/// Features are identified by the (potentially relative) path used when loading
46/// the file for the first time. Features loaded from disk are deduplicated
47/// by their real position on the underlying file system (i.e. their device and
48/// inode).
49#[derive(Debug, Hash, PartialEq, Eq)]
50pub struct Feature {
51    inner: FeatureType,
52}
53
54impl Feature {
55    /// Create a new feature from a file handle and path.
56    #[must_use]
57    #[cfg(feature = "disk")]
58    #[cfg_attr(docsrs, doc(cfg(feature = "disk")))]
59    pub fn with_handle_and_path(handle: Handle, path: PathBuf) -> Self {
60        let inner = FeatureType::with_handle_and_path(handle, path);
61        Self { inner }
62    }
63
64    /// Create a new feature from a virtual in-memory path.
65    ///
66    /// # Examples
67    ///
68    /// ```
69    /// use std::path::Path;
70    /// use mezzaluna_loaded_features::Feature;
71    ///
72    /// let feature = Feature::with_in_memory_path("/src/_lib/test.rb".into());
73    /// assert_eq!(feature.path(), Path::new("/src/_lib/test.rb"));
74    /// ```
75    #[must_use]
76    pub fn with_in_memory_path(path: PathBuf) -> Self {
77        let inner = FeatureType::with_in_memory_path(path);
78        Self { inner }
79    }
80
81    /// Get the path associated with this feature.
82    ///
83    /// The path returned by this method is not guaranteed to be the same as
84    /// the path returned by [`LoadedFeatures::features`] since features may
85    /// be deduplicated by their physical location in the underlying loaders.
86    ///
87    /// # Examples
88    ///
89    /// ```
90    /// use std::path::Path;
91    /// use mezzaluna_loaded_features::Feature;
92    ///
93    /// let feature = Feature::with_in_memory_path("/src/_lib/test.rb".into());
94    /// assert_eq!(feature.path(), Path::new("/src/_lib/test.rb"));
95    /// ```
96    ///
97    /// [`LoadedFeatures::features`]: crate::LoadedFeatures::features
98    #[must_use]
99    pub fn path(&self) -> &Path {
100        self.inner.path()
101    }
102}
mezzaluna_loaded_features/feature/mod.rs

mezzaluna_loaded_features/feature/
mod.rs
