bp3d-fs 1.1.0

Alternative to dirs-rs with better cross platform support and support for Mac/iOS app sandbox.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// Copyright (c) 2022, BlockProject 3D
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright notice,
//       this list of conditions and the following disclaimer in the documentation
//       and/or other materials provided with the distribution.
//     * Neither the name of BlockProject 3D nor the names of its contributors
//       may be used to endorse or promote products derived from this software
//       without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::borrow::Cow;
use std::ffi::OsStr;
use std::path::Path;

mod sealing {
    use std::path::Path;

    pub trait PathExt {}

    impl PathExt for Path {}
}

/// Extension trait for [Path](std::path::Path) for common functionality in BP3D software.
pub trait PathExt: sealing::PathExt {
    /// Ensures the given extension is present on a [Path](std::path::Path). Reallocates a new
    /// [PathBuf](std::path::PathBuf) if no extension is present or that the extension is incorrect.
    fn ensure_extension<S: AsRef<OsStr>>(&self, extension: S) -> Cow<Path>;
}

impl PathExt for Path {
    fn ensure_extension<S: AsRef<OsStr>>(&self, extension: S) -> Cow<Path> {
        if let Some(ext) = self.extension() {
            if ext == extension.as_ref() {
                self.into()
            } else {
                let mut buf = self.to_path_buf();
                buf.set_extension(extension);
                buf.into()
            }
        } else {
            self.with_extension(extension).into()
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::utils::PathExt;
    use std::borrow::Cow;
    use std::path::Path;

    #[test]
    fn basic() {
        let wrong_ext = Path::new("myfile.txt");
        let no_ext = Path::new("myfile");
        let correct_ext = Path::new("myfile.bpx");
        let wrong_ext_corrected = wrong_ext.ensure_extension("bpx");
        let no_ext_corrected = no_ext.ensure_extension("bpx");
        let correct_ext_corrected = correct_ext.ensure_extension("bpx");
        if let Cow::Owned(_) = correct_ext_corrected {
            panic!("If the extension is already correct no allocation should be performed")
        }
        assert_eq!(&wrong_ext_corrected, Path::new("myfile.bpx"));
        assert_eq!(&no_ext_corrected, Path::new("myfile.bpx"));
        assert_eq!(&correct_ext_corrected, Path::new("myfile.bpx"));
    }
}