graphforge-filesystem 0.6.0-rc.1

Audited native filesystem primitives for GraphForge durability
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

//! Exclusive construction and sealed-read capabilities for Windows CAS files.

use crate::ObservedSync as _;
use std::fs::File;
use std::io;

use super::FileIdentity;

/// Exclusive Windows capability used while constructing one CAS object.
#[cfg(windows)]
#[derive(Debug)]
pub struct WindowsCasWriter {
    pub(super) file: File,
    pub(super) identity: FileIdentity,
}

#[cfg(windows)]
impl io::Write for WindowsCasWriter {
    fn write(&mut self, buffer: &[u8]) -> io::Result<usize> {
        io::Write::write(&mut self.file, buffer)
    }

    fn flush(&mut self) -> io::Result<()> {
        io::Write::flush(&mut self.file)
    }
}

#[cfg(windows)]
impl io::Read for WindowsCasWriter {
    fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
        io::Read::read(&mut self.file, buffer)
    }
}

#[cfg(windows)]
impl io::Seek for WindowsCasWriter {
    fn seek(&mut self, position: io::SeekFrom) -> io::Result<u64> {
        io::Seek::seek(&mut self.file, position)
    }
}

#[cfg(windows)]
impl WindowsCasWriter {
    /// Borrow the owned writer for first-party metadata accounting.
    #[doc(hidden)]
    #[must_use]
    pub fn as_file(&self) -> &File {
        &self.file
    }

    /// Flush the exact retained writer.
    pub fn sync_all(&self) -> io::Result<()> {
        self.file.observed_sync_all()
    }

    /// Return the immutable identity captured at exclusive creation.
    #[must_use]
    pub fn identity(&self) -> FileIdentity {
        self.identity
    }
}

#[cfg(windows)]
impl crate::ObservedSync for WindowsCasWriter {
    fn observed_sync_all(&self) -> io::Result<()> {
        self.sync_all()
    }

    fn observed_sync_data(&self) -> io::Result<()> {
        self.file.observed_sync_data()
    }
}

/// Read-only Windows capability for a canonically sealed CAS object.
#[cfg(windows)]
#[derive(Debug)]
pub struct WindowsSealedCasFile(pub(super) File);

#[cfg(windows)]
impl WindowsSealedCasFile {
    /// Consume the sealed capability as a standard read-only file handle.
    #[must_use]
    pub fn into_file(self) -> File {
        self.0
    }
}

/// Exclusive retained handle for authenticating a released legacy Windows CAS object.
#[cfg(windows)]
#[derive(Debug)]
pub struct WindowsLegacyCasAdopter {
    pub(super) file: File,
    pub(super) identity: FileIdentity,
}

#[cfg(windows)]
impl io::Read for WindowsLegacyCasAdopter {
    fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
        io::Read::read(&mut self.file, buffer)
    }
}

#[cfg(windows)]
impl io::Seek for WindowsLegacyCasAdopter {
    fn seek(&mut self, position: io::SeekFrom) -> io::Result<u64> {
        io::Seek::seek(&mut self.file, position)
    }
}

#[cfg(test)]
mod tests;