serialport5 5.0.2

A cross-platform low-level serial port 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! Provides unix-only extensions to the SerialPort type.

use crate::Result;

/// Specifies the duration of a transmission break.
#[derive(Clone, Copy, Debug)]
pub enum BreakDuration {
    /// 0.25-0.5s
    Short,
    /// Specifies a break duration that is platform-dependent
    Arbitrary(std::num::NonZeroI32),
}

/// Posix-only extensions to the SerialPort type.
pub trait SerialPortExt {
    /// Create a pair of pseudo serial terminals
    ///
    /// ## Returns
    /// Two connected `SerialPort` objects: `(master, slave)`
    ///
    /// ## Errors
    /// Attempting any IO or parameter settings on the slave tty after the master
    /// tty is closed will return errors.
    ///
    /// On some platforms manipulating the master port will fail and only
    /// modifying the slave port is possible.
    ///
    /// ## Examples
    ///
    /// ```
    /// use serialport5::{SerialPort, posix::SerialPortExt};
    ///
    /// let (master, slave) = SerialPort::pair().unwrap();
    /// ```
    fn pair() -> Result<(Self, Self)>
    where
        Self: Sized;

    /// Returns the exclusivity of the port
    ///
    /// If a port is exclusive, then trying to open the same device path again
    /// will fail.
    fn exclusive(&self) -> bool;

    /// Sets the exclusivity of the port
    ///
    /// If a port is exclusive, then trying to open the same device path again
    /// will fail.
    ///
    /// See the man pages for the tiocexcl and tiocnxcl ioctl's for more details.
    ///
    /// ## Errors
    ///
    /// * `Io` for any error while setting exclusivity for the port.
    fn set_exclusive(&mut self, exclusive: bool) -> Result<()>;

    /// Sends 0-valued bits over the port for a set duration
    fn send_break(&self, duration: BreakDuration) -> Result<()>;
}

impl SerialPortExt for crate::SerialPort {
    fn pair() -> Result<(Self, Self)> {
        let (master, slave) = crate::sys::SerialPort::pair()?;
        Ok((crate::SerialPort(master), crate::SerialPort(slave)))
    }

    fn exclusive(&self) -> bool {
        self.0.exclusive()
    }

    fn set_exclusive(&mut self, exclusive: bool) -> Result<()> {
        self.0.set_exclusive(exclusive)
    }

    fn send_break(&self, duration: BreakDuration) -> Result<()> {
        self.0.send_break(duration)
    }
}