termal_core 5.0.0

This library contains implementation for the termal 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
47
48
49
50
51
52
53
54
55

use std::{
    io::{Stdin, StdinLock},
    time::Duration,
};

use crate::Result;

use super::wait_for_stdin;

/// The type can wait for input with the given timeout.
pub trait WaitForIn {
    /// Waits for input with the given timeout.
    ///
    /// - [`Duration::ZERO`] means no blocking.
    /// - [`Duration::MAX`] means wait indefinitely.
    fn wait_for_in(&self, timeout: Duration) -> Result<bool>;
}

impl WaitForIn for Stdin {
    /// Wait for any event on stdin, but not longer than the timeout.
    ///
    /// Calls [`wait_for_stdin`].
    ///
    /// If timeout is [`Duration::MAX`], this will wait indefinitely.
    ///
    /// # Returns
    /// `true` if there is event on stdin. If this returns due to timeout or
    /// interrupt, returns `false`.
    ///
    /// # Support
    /// - Unix (Linux)
    /// - Windows (not tested)
    fn wait_for_in(&self, timeout: Duration) -> Result<bool> {
        wait_for_stdin(timeout)
    }
}

impl WaitForIn for StdinLock<'static> {
    /// Wait for any event on stdin, but not longer than the timeout.
    ///
    /// Calls [`wait_for_stdin`].
    ///
    /// If timeout is [`Duration::MAX`], this will wait indefinitely.
    ///
    /// # Returns
    /// `true` if there is event on stdin. If this returns due to timeout or
    /// interrupt, returns `false`.
    ///
    /// # Support
    /// - Unix (Linux)
    /// - Windows (not tested)
    fn wait_for_in(&self, timeout: Duration) -> Result<bool> {
        wait_for_stdin(timeout)
    }
}