clawless-core 0.8.0

Types and traits for building command-line applications
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

/// Whether a user is present who can answer the application
///
/// The code that builds the [`Context`] sets this value. The default is [`NonInteractive`], so
/// a context reports a user only when that code found one.
///
/// # Examples
///
/// ```
/// use clawless_core::context::Interactivity;
///
/// let interactivity = Interactivity::default();
/// assert_eq!(interactivity, Interactivity::NonInteractive);
/// ```
///
/// [`Context`]: super::Context
/// [`NonInteractive`]: Interactivity::NonInteractive
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub enum Interactivity {
    /// A user is present and can answer
    Interactive,
    /// No user can answer
    #[default]
    NonInteractive,
}

#[cfg(test)]
mod tests {
    // An assertion in a test panics by design. A `# Panics` section on every test
    // would repeat that and give the reader no information.
    #![allow(clippy::missing_panics_doc)]

    use super::*;

    #[test]
    fn default_is_non_interactive() {
        let interactivity = Interactivity::default();

        assert_eq!(interactivity, Interactivity::NonInteractive);
    }

    #[test]
    fn trait_send() {
        fn assert_send<T: Send>() {}
        assert_send::<Interactivity>();
    }

    #[test]
    fn trait_sync() {
        fn assert_sync<T: Sync>() {}
        assert_sync::<Interactivity>();
    }

    #[test]
    fn trait_unpin() {
        fn assert_unpin<T: Unpin>() {}
        assert_unpin::<Interactivity>();
    }
}