rsfdisk 0.2.0

Safe Rust wrapper around the `util-linux/libfdisk` C library
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

// Copyright (c) 2023 Nick Piaddo
// SPDX-License-Identifier: Apache-2.0 OR MIT

// From dependency library

// From standard library

// From this library

/// A prompt menu item.
#[derive(Debug)]
pub struct MenuItem {
    name: String,
    description: String,
    key_code: i32,
}

impl MenuItem {
    #[doc(hidden)]
    #[allow(dead_code)]
    /// Creates a new `MenuItem`.
    pub(crate) fn new(name: String, description: String, key_code: i32) -> MenuItem {
        log::debug!("MenuItem::new creating a new `MenuItem` instance with name: {:?}, description: {:?}, key code: {:?}", name, description, key_code);

        Self {
            name,
            description,
            key_code,
        }
    }

    /// Returns the `MenuItem`'s name.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Returns the `MenuItem`'s description.
    pub fn description(&self) -> &str {
        &self.description
    }

    /// Returns the keyboard key code associated with this `MenuItem`.
    pub fn key_code(&self) -> i32 {
        self.key_code
    }
}