file-lock 2.1.11

File locking via POSIX advisory record locks
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

use std::fs::{File, OpenOptions};
use std::path::Path;

/// A wrapper around the open options type
/// that can be queried for the write permissions
///
/// This type has the exact same API as [`std::fs::OpenOptions`]
/// with the exception that the confluent interface passes `self`
/// rather than `&mut self`.
pub struct FileOptions {
    open_options: OpenOptions,
    pub(crate) writeable: bool,
}

impl FileOptions {
    pub fn new() -> Self {
        Self {
            open_options: OpenOptions::new(),
            writeable: false,
        }
    }

    pub fn append(mut self, append: bool) -> Self {
        self.open_options.append(append);
        self.writeable = true;
        self
    }

    pub fn create(mut self, create: bool) -> Self {
        self.open_options.create(create);
        self
    }

    pub fn create_new(mut self, create_new: bool) -> Self {
        self.open_options.create_new(create_new);
        self
    }

    pub fn open<P: AsRef<Path>>(&self, path: P) -> std::io::Result<File> {
        self.open_options.open(path)
    }

    pub fn read(mut self, read: bool) -> Self {
        self.open_options.read(read);
        self
    }

    pub fn truncate(mut self, truncate: bool) -> Self {
        self.open_options.truncate(truncate);
        self
    }

    pub fn write(mut self, write: bool) -> Self {
        self.open_options.write(write);
        self.writeable = write;
        self
    }
}

impl Default for FileOptions {
    fn default() -> Self {
        Self::new()
    }
}