runite 0.1.0

An event-loop-per-thread async runtime built on io_uring (Linux), kqueue (macOS), and IOCP (Windows)
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

//! Windows-specific extensions for [`crate::fs`] types, mirroring
//! [`std::os::windows::fs`].

/// Windows-specific extensions to [`crate::fs::OpenOptions`], mirroring
/// [`std::os::windows::fs::OpenOptionsExt`].
///
/// The configured values are forwarded to `CreateFileW` when the file is
/// opened. runite always adds `FILE_FLAG_OVERLAPPED` to the custom flags so
/// the handle can be driven by the completion-port backend.
///
/// # Examples
///
/// ```no_run
/// use runite::os::windows::fs::OpenOptionsExt;
///
/// runite::spawn(async {
///     let mut options = runite::fs::OpenOptions::new();
///     options.read(true);
///     // FILE_SHARE_READ | FILE_SHARE_WRITE
///     options.share_mode(0x1 | 0x2);
///     let _file = options.open("data.bin").await.unwrap();
/// });
/// runite::run();
/// ```
pub trait OpenOptionsExt {
    /// Overrides the access rights passed to `CreateFileW` with `access`,
    /// replacing the rights derived from `read`/`write`/`append`. See
    /// [`std::os::windows::fs::OpenOptionsExt::access_mode`].
    fn access_mode(&mut self, access: u32) -> &mut Self;

    /// Overrides the share mode passed to `CreateFileW`. See
    /// [`std::os::windows::fs::OpenOptionsExt::share_mode`].
    fn share_mode(&mut self, share: u32) -> &mut Self;

    /// Adds extra flags to the `dwFlagsAndAttributes` argument of
    /// `CreateFileW` (`FILE_FLAG_OVERLAPPED` is always added). See
    /// [`std::os::windows::fs::OpenOptionsExt::custom_flags`].
    fn custom_flags(&mut self, flags: u32) -> &mut Self;

    /// Sets the file attribute bits used when a new file is created. See
    /// [`std::os::windows::fs::OpenOptionsExt::attributes`].
    fn attributes(&mut self, attributes: u32) -> &mut Self;

    /// Sets the `SECURITY_SQOS_PRESENT` quality-of-service flags. See
    /// [`std::os::windows::fs::OpenOptionsExt::security_qos_flags`].
    fn security_qos_flags(&mut self, flags: u32) -> &mut Self;
}

impl OpenOptionsExt for crate::fs::OpenOptions {
    fn access_mode(&mut self, access: u32) -> &mut Self {
        self.platform_options_mut().access_mode = Some(access);
        self
    }

    fn share_mode(&mut self, share: u32) -> &mut Self {
        self.platform_options_mut().share_mode = Some(share);
        self
    }

    fn custom_flags(&mut self, flags: u32) -> &mut Self {
        self.platform_options_mut().custom_flags = flags;
        self
    }

    fn attributes(&mut self, attributes: u32) -> &mut Self {
        self.platform_options_mut().attributes = attributes;
        self
    }

    fn security_qos_flags(&mut self, flags: u32) -> &mut Self {
        self.platform_options_mut().security_qos_flags = flags;
        self
    }
}

/// Windows-specific extensions to [`crate::fs::Metadata`], mirroring
/// [`std::os::windows::fs::MetadataExt`].
pub trait MetadataExt {
    /// Returns the raw `dwFileAttributes` bits for the file, as reported by
    /// `GetFileInformationByHandle`. See
    /// [`std::os::windows::fs::MetadataExt::file_attributes`].
    fn file_attributes(&self) -> u32;
}

impl MetadataExt for crate::fs::Metadata {
    fn file_attributes(&self) -> u32 {
        self.platform_metadata().file_attributes
    }
}