bp3d_fs/utils/
path.rs

1// Copyright (c) 2022, 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::borrow::Cow;
30use std::ffi::OsStr;
31use std::path::Path;
32
33mod sealing {
34    use std::path::Path;
35
36    pub trait PathExt {}
37
38    impl PathExt for Path {}
39}
40
41/// Extension trait for [Path](std::path::Path) for common functionality in BP3D software.
42pub trait PathExt: sealing::PathExt {
43    /// Ensures the given extension is present on a [Path](std::path::Path). Reallocates a new
44    /// [PathBuf](std::path::PathBuf) if no extension is present or that the extension is incorrect.
45    fn ensure_extension<S: AsRef<OsStr>>(&self, extension: S) -> Cow<Path>;
46}
47
48impl PathExt for Path {
49    fn ensure_extension<S: AsRef<OsStr>>(&self, extension: S) -> Cow<Path> {
50        if let Some(ext) = self.extension() {
51            if ext == extension.as_ref() {
52                self.into()
53            } else {
54                let mut buf = self.to_path_buf();
55                buf.set_extension(extension);
56                buf.into()
57            }
58        } else {
59            self.with_extension(extension).into()
60        }
61    }
62}
63
64#[cfg(test)]
65mod tests {
66    use crate::utils::PathExt;
67    use std::borrow::Cow;
68    use std::path::Path;
69
70    #[test]
71    fn basic() {
72        let wrong_ext = Path::new("myfile.txt");
73        let no_ext = Path::new("myfile");
74        let correct_ext = Path::new("myfile.bpx");
75        let wrong_ext_corrected = wrong_ext.ensure_extension("bpx");
76        let no_ext_corrected = no_ext.ensure_extension("bpx");
77        let correct_ext_corrected = correct_ext.ensure_extension("bpx");
78        if let Cow::Owned(_) = correct_ext_corrected {
79            panic!("If the extension is already correct no allocation should be performed")
80        }
81        assert_eq!(&wrong_ext_corrected, Path::new("myfile.bpx"));
82        assert_eq!(&no_ext_corrected, Path::new("myfile.bpx"));
83        assert_eq!(&correct_ext_corrected, Path::new("myfile.bpx"));
84    }
85}
bp3d_fs/utils/path.rs

bp3d_fs/utils/
path.rs
