devela 0.28.0

A development substrate of coherence.
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

// devela::sys::os::linux::io::term::cc
//
//! Typed Linux termios special-character indices.
//

use crate::LINUX_TERMIOS_CC as CC;

#[doc = crate::_tags!(linux term)]
/// A symbolic index into [`LinuxTermios::c_cc`][crate::LinuxTermios::c_cc].
#[doc = crate::_doc_meta!{
    location("sys/os/linux/io/term"),
    test_size_of(LinuxTermiosCc = 1|8),
}]
///
/// These constants identify slots in the terminal control-character array.
/// They are indices, not character values.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct LinuxTermiosCc(u8);

impl LinuxTermiosCc {
    /// The number of Linux termios control-character slots.
    pub const COUNT: usize = 19; // would be CC::NCCS

    /// Interrupt character.
    pub const VINTR: Self = Self(CC::VINTR);
    /// Quit character.
    pub const VQUIT: Self = Self(CC::VQUIT);
    /// Erase character.
    pub const VERASE: Self = Self(CC::VERASE);
    /// Kill character.
    pub const VKILL: Self = Self(CC::VKILL);
    /// End-of-file character.
    pub const VEOF: Self = Self(CC::VEOF);
    /// Timeout value for noncanonical reads.
    pub const VTIME: Self = Self(CC::VTIME);
    /// Minimum byte count for noncanonical reads.
    pub const VMIN: Self = Self(CC::VMIN);
    /// Switch character.
    pub const VSWTC: Self = Self(CC::VSWTC);
    /// Start character.
    pub const VSTART: Self = Self(CC::VSTART);
    /// Stop character.
    pub const VSTOP: Self = Self(CC::VSTOP);
    /// Suspend character.
    pub const VSUSP: Self = Self(CC::VSUSP);
    /// Additional end-of-line character.
    pub const VEOL: Self = Self(CC::VEOL);
    /// Reprint unread characters.
    pub const VREPRINT: Self = Self(CC::VREPRINT);
    /// Discard pending output.
    pub const VDISCARD: Self = Self(CC::VDISCARD);
    /// Word erase character.
    pub const VWERASE: Self = Self(CC::VWERASE);
    /// Literal next character.
    pub const VLNEXT: Self = Self(CC::VLNEXT);
    /// Second additional end-of-line character.
    pub const VEOL2: Self = Self(CC::VEOL2);

    /// Returns a checked control-character index.
    #[must_use]
    pub const fn new(index: u8) -> Option<Self> {
        if (index as usize) < Self::COUNT { Some(Self(index)) } else { None }
    }
    /// Returns the raw index as `u8`.
    #[must_use]
    pub const fn as_u8(self) -> u8 {
        self.0
    }
    /// Returns the raw index as `usize`.
    #[must_use]
    pub const fn index(self) -> usize {
        self.0 as usize
    }
    const _ASSERT_RAW_VALUES: () = {
        assert!(Self::VINTR.index() == CC::VINTR as usize);
        assert!(Self::VQUIT.index() == CC::VQUIT as usize);
        assert!(Self::VERASE.index() == CC::VERASE as usize);
        assert!(Self::VKILL.index() == CC::VKILL as usize);
        assert!(Self::VEOF.index() == CC::VEOF as usize);
        assert!(Self::VTIME.index() == CC::VTIME as usize);
        assert!(Self::VMIN.index() == CC::VMIN as usize);
        assert!(Self::VSWTC.index() == CC::VSWTC as usize);
        assert!(Self::VSTART.index() == CC::VSTART as usize);
        assert!(Self::VSTOP.index() == CC::VSTOP as usize);
        assert!(Self::VSUSP.index() == CC::VSUSP as usize);
        assert!(Self::VEOL.index() == CC::VEOL as usize);
        assert!(Self::VREPRINT.index() == CC::VREPRINT as usize);
        assert!(Self::VDISCARD.index() == CC::VDISCARD as usize);
        assert!(Self::VWERASE.index() == CC::VWERASE as usize);
        assert!(Self::VLNEXT.index() == CC::VLNEXT as usize);
        assert!(Self::VEOL2.index() == CC::VEOL2 as usize);
    };
}