wslplugins-rs 0.1.0-beta.2

A Rust framework for developing WSL plugins using safe and idiomatic Rust.
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

//! # WSL VM Creation Settings
//!
//! This module provides a safe abstraction for handling WSL VM creation settings. It wraps the
//! `WSLVmCreationSettings` structure from the WSL Plugin API and provides utilities for accessing
//! custom configuration flags with support for multiple flag management libraries.

use std::fmt::Debug;

use crate::WSLUserConfiguration;

/// Represents WSL VM creation settings.
///
/// This struct wraps the `WSLVmCreationSettings` structure from the WSL Plugin API, providing
/// safe and idiomatic Rust access to its fields.
#[repr(transparent)]
pub struct WSLVmCreationSettings(wslpluginapi_sys::WSLVmCreationSettings);

impl From<wslpluginapi_sys::WSLVmCreationSettings> for WSLVmCreationSettings {
    #[inline]
    fn from(value: wslpluginapi_sys::WSLVmCreationSettings) -> Self {
        Self(value)
    }
}

impl From<WSLVmCreationSettings> for wslpluginapi_sys::WSLVmCreationSettings {
    #[inline]
    fn from(value: WSLVmCreationSettings) -> Self {
        value.0
    }
}

impl AsRef<wslpluginapi_sys::WSLVmCreationSettings> for WSLVmCreationSettings {
    #[inline]
    fn as_ref(&self) -> &wslpluginapi_sys::WSLVmCreationSettings {
        &self.0
    }
}

impl AsRef<WSLVmCreationSettings> for wslpluginapi_sys::WSLVmCreationSettings {
    #[inline]
    fn as_ref(&self) -> &WSLVmCreationSettings {
        // SAFETY: conveting this kind of ref is safe as it is transparent
        unsafe { &*std::ptr::from_ref::<Self>(self).cast::<WSLVmCreationSettings>() }
    }
}

impl WSLVmCreationSettings {
    /// Retrieves the custom configuration flags for the VM.
    ///
    /// # Returns
    /// A wrapper type representing the custom configuration flags.
    ///
    /// This type can be converted to a flag type when the corresponding feature is enabled:
    /// - **`bitflags`**: Uses the [`bitflags`] crate for flag management.
    /// - **`flagset`**: Uses the [`flagset`] crate for flag management.
    /// - **`enumflags2`**: Uses the [`enumflags2`] crate for flag management.
    ///
    /// [`bitflags`]: https://docs.rs/bitflags
    /// [`flagset`]: https://docs.rs/flagset
    /// [`enumflags2`]: https://docs.rs/enumflags2
    #[must_use]
    #[inline]
    pub fn custom_configuration_flags(&self) -> WSLUserConfiguration {
        WSLUserConfiguration::from(self.0.CustomConfigurationFlags)
    }
}

impl Debug for WSLVmCreationSettings {
    /// Formats the VM creation settings for debugging.
    ///
    /// The debug output includes the custom configuration flags.
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("WSLVmCreationSettings")
            .field(
                "customConfigurationFlags",
                &self.custom_configuration_flags(),
            )
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use crate::utils::test_transparence;

    use super::WSLVmCreationSettings;

    #[test]
    fn test_layouts() {
        test_transparence::<wslpluginapi_sys::WSLVmCreationSettings, WSLVmCreationSettings>();
    }
}