usbfs 0.1.1

Port of the usbfs Linux userspace library in pure 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
94
95
96
97
98
99
100
101
102
103
104
105

use std::fmt;

/// Represents a USBFS interface setting.
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct UsbfsSetInterface {
    interface: u32,
    altsetting: u32,
}

impl UsbfsSetInterface {
    /// Creates a new [UsbfsSetInterface].
    pub const fn new() -> Self {
        Self {
            interface: 0,
            altsetting: 0,
        }
    }

    /// Creates a new [UsbfsSetInterface] from the provided parameters.
    pub const fn create(interface: u32, altsetting: u32) -> Self {
        Self {
            interface,
            altsetting,
        }
    }

    /// Gets the interface.
    pub const fn interface(&self) -> u32 {
        self.interface
    }

    /// Gets a mutable reference to the interface.
    pub fn interface_mut(&mut self) -> &mut u32 {
        &mut self.interface
    }

    /// Sets the interface.
    pub fn set_interface(&mut self, interface: u32) {
        self.interface = interface;
    }

    /// Sets the interface.
    pub fn with_interface(mut self, interface: u32) -> Self {
        self.set_interface(interface);
        self
    }

    /// Gets the altsetting.
    pub const fn altsetting(&self) -> u32 {
        self.altsetting
    }

    /// Sets the altsetting.
    pub fn set_altsetting(&mut self, altsetting: u32) {
        self.altsetting = altsetting;
    }

    /// Builder function that sets the altsetting.
    pub fn with_altsetting(mut self, altsetting: u32) -> Self {
        self.set_altsetting(altsetting);
        self
    }
}

impl fmt::Display for UsbfsSetInterface {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{{")?;
        write!(f, r#""interface": {}, "#, self.interface)?;
        write!(f, r#""altsetting": {}"#, self.altsetting)?;
        write!(f, "}}")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_usbfs_set_interface() {
        let exp_interface = 1;
        let exp_altsetting = 2;
        let exp_iface = UsbfsSetInterface::create(exp_interface, exp_altsetting);
        let mut null_iface = UsbfsSetInterface::new();

        assert_eq!(exp_iface.interface(), exp_interface);
        assert_eq!(exp_iface.altsetting(), exp_altsetting);

        assert_eq!(null_iface.interface(), 0);
        assert_eq!(null_iface.altsetting(), 0);

        null_iface.set_interface(exp_interface);
        assert_eq!(null_iface.interface(), exp_interface);

        null_iface.set_altsetting(exp_altsetting);
        assert_eq!(null_iface.altsetting(), exp_altsetting);

        assert_eq!(
            UsbfsSetInterface::new()
                .with_interface(exp_interface)
                .with_altsetting(exp_altsetting),
            exp_iface
        );
    }
}