path-extra 0.1.1

Extra methods on `Path` for ergonomic and chainable `fs` operations.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

#[cfg(unix)]
use std::os::unix::fs::PermissionsExt as _;
use std::{
    fs::{File, OpenOptions, Permissions},
    io,
    path::Path,
};

pub trait FileExt {
    fn create_new_if_not_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>>
    where
        Self: Sized;

    fn create_if_not_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>>
    where
        Self: Sized;

    fn open_if_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>>
    where
        Self: Sized;

    fn with_permissions(&self, perm: Permissions) -> io::Result<&Self>;

    fn with_permissions_readonly(&self, readonly: bool) -> io::Result<&Self>;

    #[cfg(unix)]
    fn with_permissions_mode(&self, mode: u32) -> io::Result<&Self>;
    #[cfg(unix)]
    fn add_permissions_mode(&self, mode: u32) -> io::Result<&Self>;
    #[cfg(unix)]
    fn remove_permissions_mode(&self, mode: u32) -> io::Result<&Self>;
}

impl FileExt for File {
    #[inline]
    fn create_new_if_not_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>> {
        match Self::create_new(path) {
            Ok(file) => Ok(Some(file)),
            Err(err) if err.kind() == io::ErrorKind::AlreadyExists => Ok(None),
            Err(err) => Err(err),
        }
    }

    #[inline]
    fn create_if_not_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>> {
        let mut options = Self::options();

        options.write(true).create_new(true);

        options.open_if_not_exists(path)
    }

    #[inline]
    fn open_if_exists(path: impl AsRef<Path>) -> io::Result<Option<Self>> {
        match Self::open(path) {
            Ok(file) => Ok(Some(file)),
            Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
            Err(err) => Err(err),
        }
    }

    #[inline]
    fn with_permissions(&self, perm: Permissions) -> io::Result<&Self> {
        self.set_permissions(perm)?;

        Ok(self)
    }

    #[inline]
    fn with_permissions_readonly(&self, readonly: bool) -> io::Result<&Self> {
        let meta = self.metadata()?;

        let mut perm = meta.permissions();

        perm.set_readonly(readonly);

        self.with_permissions(perm)
    }

    #[cfg(unix)]
    #[inline]
    fn with_permissions_mode(&self, mode: u32) -> io::Result<&Self> {
        let perm = Permissions::from_mode(mode);

        self.with_permissions(perm)
    }

    #[cfg(unix)]
    #[inline]
    fn add_permissions_mode(&self, mode: u32) -> io::Result<&Self> {
        let meta = self.metadata()?;

        let perm = meta.permissions();

        self.with_permissions_mode(perm.mode() | mode)
    }

    #[cfg(unix)]
    #[inline]
    fn remove_permissions_mode(&self, mode: u32) -> io::Result<&Self> {
        let meta = self.metadata()?;

        let perm = meta.permissions();

        self.with_permissions_mode(perm.mode() & !mode)
    }
}

pub trait OpenOptionsExt {
    fn open_if_not_exists(&self, path: impl AsRef<Path>) -> io::Result<Option<File>>;
    fn open_if_exists(&self, path: impl AsRef<Path>) -> io::Result<Option<File>>;
}

impl OpenOptionsExt for OpenOptions {
    #[inline]
    fn open_if_not_exists(&self, path: impl AsRef<Path>) -> io::Result<Option<File>> {
        match self.open(path) {
            Ok(file) => Ok(Some(file)),
            Err(err) if err.kind() == io::ErrorKind::AlreadyExists => Ok(None),
            Err(err) => Err(err),
        }
    }

    #[inline]
    fn open_if_exists(&self, path: impl AsRef<Path>) -> io::Result<Option<File>> {
        match self.open(path) {
            Ok(file) => Ok(Some(file)),
            Err(err) if err.kind() == io::ErrorKind::NotFound => Ok(None),
            Err(err) => Err(err),
        }
    }
}