bp3d_os/dirs/
path.rs

1// Copyright (c) 2025, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use std::io::Result;
30use std::path::{Path, PathBuf};
31
32/// An application path.
33pub struct AppPath<'a> {
34    path: &'a Path,
35}
36
37impl<'a> AsRef<Path> for AppPath<'a> {
38    fn as_ref(&self) -> &Path {
39        self.path
40    }
41}
42
43impl<'a> AppPath<'a> {
44    pub(crate) fn new(path: &'a Path) -> Self {
45        AppPath { path }
46    }
47
48    /// Create the underlying path if it does not exist and return it.
49    ///
50    /// # Errors
51    ///
52    /// This function returns [Error](std::io::Error) if the path couldn't be created.
53    pub fn create(&self) -> Result<&'a Path> {
54        if !self.path.is_dir() {
55            std::fs::create_dir_all(self.path)?;
56        }
57        Ok(self.path)
58    }
59
60    /// Create the underlying path if it does not exist and join a new path to it.
61    ///
62    /// # Errors
63    ///
64    /// This function returns [Error](std::io::Error) if the path couldn't be created.
65    pub fn create_join<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf> {
66        Ok(self.create()?.join(path))
67    }
68
69    /// Joins the underlying path with another component and returns the joint path.
70    pub fn join<P: AsRef<Path>>(&self, path: P) -> PathBuf {
71        self.path.join(path)
72    }
73}
bp3d_os/dirs/path.rs

bp3d_os/dirs/
path.rs
