wslpluginapi-sys 0.2.0+2.4.4

Rust bindings for the WSL Plugin API
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use crate::WSLPluginAPIV1;
use windows_sys::core::HRESULT;
use windows_sys::Win32::Foundation::{SEVERITY_ERROR, S_OK};
use windows_sys::Win32::System::Diagnostics::Debug::{FACILITY_CODE, FACILITY_ITF};

#[inline(always)]
const fn make_hresult(severity: u32, facility: FACILITY_CODE, code: u32) -> HRESULT {
    ((severity << 31) | (facility << 16) | code) as HRESULT
}

/// Error code indicating that the WSL version is too low and requires an update for this specific plugin API.
pub const WSL_E_PLUGIN_REQUIRES_UPDATE: HRESULT =
    make_hresult(SEVERITY_ERROR, FACILITY_ITF, 0x8004032A);

/// Ensures the WSL Plugin API version meets the minimum required version.
///
/// This function compares the version of the API passed as a parameter against the required
/// version numbers specified (`required_major`, `required_minor`, `required_revision`).
/// If the API version is lower than required, it returns `WSL_E_PLUGIN_REQUIRES_UPDATE`.
/// Otherwise, it returns `S_OK`.
///
/// # Parameters
///
/// - `required_major`: The major version number required by the plugin.
/// - `required_minor`: The minor version number required by the plugin.
/// - `required_revision`: The revision number required by the plugin.
/// - `api`: A raw pointer to a [`WSLPluginAPIV1`] structure, containing the current API version.
///
/// # Returns
///
/// - [`S_OK`]: If the API version meets or exceeds the required version.
/// - [`WSL_E_PLUGIN_REQUIRES_UPDATE`]: If the API version is below the required minimum.
///
/// # Safety
///
/// This function is `unsafe` because it dereferences a raw pointer (`api`). The caller must
/// ensure that the pointer is valid and points to a properly initialized [`WSLPluginAPIV1`]
/// structure.
#[inline(always)]
pub const unsafe fn require_version(
    required_major: u32,
    required_minor: u32,
    required_revision: u32,
    api: *const WSLPluginAPIV1,
) -> HRESULT {
    let version = &(*api).Version;

    if version.Major < required_major
        || (version.Major == required_major && version.Minor < required_minor)
        || (version.Major == required_major
            && version.Minor == required_minor
            && version.Revision < required_revision)
    {
        WSL_E_PLUGIN_REQUIRES_UPDATE
    } else {
        S_OK
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{WSLPluginAPIV1, WSLVersion};
    use windows_sys::Win32::Foundation::S_OK;

    #[test]
    fn test_version_exact_match() {
        let api = WSLPluginAPIV1 {
            Version: WSLVersion {
                Major: 1,
                Minor: 0,
                Revision: 0,
            },
            MountFolder: None,
            ExecuteBinary: None,
            PluginError: None,
            ExecuteBinaryInDistribution: None,
        };

        assert_eq!(unsafe { require_version(1, 0, 0, &api) }, S_OK);
    }

    #[test]
    fn test_version_major_too_low() {
        let api = WSLPluginAPIV1 {
            Version: WSLVersion {
                Major: 0,
                Minor: 9,
                Revision: 0,
            },
            MountFolder: None,
            ExecuteBinary: None,
            PluginError: None,
            ExecuteBinaryInDistribution: None,
        };

        assert_eq!(
            unsafe { require_version(1, 0, 0, &api) },
            WSL_E_PLUGIN_REQUIRES_UPDATE
        );
    }

    #[test]
    fn test_version_minor_too_low() {
        let api = WSLPluginAPIV1 {
            Version: WSLVersion {
                Major: 1,
                Minor: 0,
                Revision: 0,
            },
            MountFolder: None,
            ExecuteBinary: None,
            PluginError: None,
            ExecuteBinaryInDistribution: None,
        };

        assert_eq!(
            unsafe { require_version(1, 1, 0, &api) },
            WSL_E_PLUGIN_REQUIRES_UPDATE
        );
    }

    #[test]
    fn test_version_revision_too_low() {
        let api = WSLPluginAPIV1 {
            Version: WSLVersion {
                Major: 1,
                Minor: 0,
                Revision: 0,
            },
            MountFolder: None,
            ExecuteBinary: None,
            PluginError: None,
            ExecuteBinaryInDistribution: None,
        };

        assert_eq!(
            unsafe { require_version(1, 0, 1, &api) },
            WSL_E_PLUGIN_REQUIRES_UPDATE
        );
    }

    #[test]
    fn test_version_high_enough() {
        let api = WSLPluginAPIV1 {
            Version: WSLVersion {
                Major: 1,
                Minor: 2,
                Revision: 3,
            },
            MountFolder: None,
            ExecuteBinary: None,
            PluginError: None,
            ExecuteBinaryInDistribution: None,
        };

        assert_eq!(unsafe { require_version(1, 0, 1, &api) }, S_OK);
    }
}