path-extra 0.1.0

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

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

use tokio::fs::{File, OpenOptions};

#[trait_variant::make(Send)]
pub trait FileExt {
    async fn open_if_exists(path: impl AsRef<Path> + Send) -> io::Result<Option<Self>>
    where
        Self: Sized;

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

    async fn create_new_if_not_exists(path: impl AsRef<Path> + Send) -> io::Result<Option<Self>>
    where
        Self: Sized;

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

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

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

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

        options.open_if_not_exists(path).await
    }

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

    #[cfg(unix)]
    #[inline]
    async fn set_permissions_mode(&self, permissions_mode: u32) -> io::Result<&Self> {
        let metadata = self.metadata().await?;

        let mut permissions = metadata.permissions();

        permissions.set_mode(permissions_mode);

        self.set_permissions(permissions).await?;

        Ok(self)
    }

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

        let mut permissions = metadata.permissions();

        permissions.set_mode(permissions.mode() | permissions_mode);

        self.set_permissions(permissions).await?;

        Ok(self)
    }

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

        let mut permissions = metadata.permissions();

        permissions.set_mode(permissions.mode() & !permissions_mode);

        self.set_permissions(permissions).await?;

        Ok(self)
    }
}

#[trait_variant::make(Send)]
pub trait OpenOptionsExt {
    async fn open_if_exists(&self, path: impl AsRef<Path> + Send) -> io::Result<Option<File>>;

    async fn open_if_not_exists(&self, path: impl AsRef<Path> + Send) -> io::Result<Option<File>>;
}

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

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