Skip to main content

elemental_core/storage/
layout.rs

1use std::{
2    fmt::Debug,
3    path::{Path, PathBuf},
4};
5
6use crate::storage::error::{Error, Result};
7
8pub trait Layout: Send + Sync {
9    type Resource: Send + 'static;
10    type ExtendedResource: Send + 'static;
11
12    fn get_resource(&self, root: &Path, resource: Self::Resource) -> Option<PathBuf>;
13    fn get_extended_resource(
14        &self,
15        root: &Path,
16        resource: Self::ExtendedResource,
17    ) -> Option<PathBuf>;
18    fn name(&self) -> &'static str;
19
20    fn try_get_resource(&self, root: &Path, resource: Self::Resource) -> Result<PathBuf>
21    where
22        Self::Resource: Debug,
23    {
24        let resource_name = format!("{resource:?}");
25        self.get_resource(root, resource)
26            .ok_or_else(|| Error::ResourceNotFound {
27                layout: self.name(),
28                resource: resource_name,
29                root: root.to_path_buf(),
30            })
31    }
32
33    fn try_get_extended_resource(
34        &self,
35        root: &Path,
36        resource: Self::ExtendedResource,
37    ) -> Result<PathBuf>
38    where
39        Self::ExtendedResource: Debug,
40    {
41        let resource_name = format!("{resource:?}");
42        self.get_extended_resource(root, resource)
43            .ok_or_else(|| Error::ResourceNotFound {
44                layout: self.name(),
45                resource: resource_name,
46                root: root.to_path_buf(),
47            })
48    }
49}
50
51pub trait Layoutable<L: Layout> {
52    fn layout(&self) -> &L;
53    fn root_path(&self) -> &Path;
54
55    fn get_resource(&self, resource: L::Resource) -> Option<PathBuf> {
56        self.layout().get_resource(self.root_path(), resource)
57    }
58
59    fn try_get_resource(&self, resource: L::Resource) -> Result<PathBuf>
60    where
61        L::Resource: Debug,
62    {
63        self.layout().try_get_resource(self.root_path(), resource)
64    }
65
66    fn get_existing_resource(&self, resource: L::Resource) -> Option<PathBuf> {
67        self.get_resource(resource).filter(|path| path.exists())
68    }
69
70    fn get_extended_resource(&self, resource: L::ExtendedResource) -> Option<PathBuf> {
71        self.layout()
72            .get_extended_resource(self.root_path(), resource)
73    }
74
75    fn try_get_extended_resource(&self, resource: L::ExtendedResource) -> Result<PathBuf>
76    where
77        L::ExtendedResource: Debug,
78    {
79        self.layout()
80            .try_get_extended_resource(self.root_path(), resource)
81    }
82}
83
84impl Layout for () {
85    type Resource = ();
86    type ExtendedResource = ();
87
88    fn get_resource(&self, _root: &Path, _resource: Self::Resource) -> Option<PathBuf> {
89        None
90    }
91
92    fn get_extended_resource(
93        &self,
94        _root: &Path,
95        _resource: Self::ExtendedResource,
96    ) -> Option<PathBuf> {
97        None
98    }
99
100    fn name(&self) -> &'static str {
101        "empty"
102    }
103}