Struct TTYPort

pub struct TTYPort { /* private fields */ }

A TTY port

Implementations

impl TTYPort

pub fn new( path: String, settings: Option<SerialPortSettings>, ) -> SerialResult<Self>

Creates a new TTY port

Examples found in repository

examples/port_list.rs (lines 44-50)

fn main() {

    #[cfg(windows)]
    {
        let mut scanner = port_lister::COMPortLister{};
        for port in scanner.list_devices().unwrap() {
            println!("Found port:");
            println!("\tPort: {}", port.get_port());
            println!("\tDescription: {}", port.get_desc());
            println!("\tManufacturer: {}", port.get_manufacturer());
        }
    }

    #[cfg(unix)]
    {
        let mut scanner = port_lister::TTYPortScanner{};
        for port in scanner.list_devices().unwrap() {
            println!("Found port:");
            println!("\tPort: {}", port.get_port());
            println!("\tDescription: {}", port.get_desc());
            println!("\tManufacturer: {}", port.get_manufacturer());
        }
    }

    #[cfg(windows)]
    let p = COMPort::new("COM7".into(), Some(
        SerialPortSettings::default()
            .baud(115200)
            .read_timeout(Some(100))
            .write_timeout(Some(100))
            .set_flow_control(FlowControl::None)
    ));
    #[cfg(unix)]
    let p = TTYPort::new("/dev/ttyUSB0".into(), Some(
        SerialPortSettings::default()
            .baud(115200)
            .read_timeout(Some(100))
            .write_timeout(Some(100))
            .set_flow_control(FlowControl::None)
    ));
    match p {
        Ok(mut port) => {
            let clone_r = port.try_clone().unwrap();
            let mut clone_w = port.try_clone().unwrap();
            println!("Port open OK!");
            let test_msg: &[u8] = "#07E11092\n".as_bytes();
            let mut buf_reader = BufReader::new(clone_r);
            let mut b = String::new();
            loop {
                if buf_reader.read_line(&mut b).is_ok() {
                    print!("IN : {}", b);
                    b.clear();
                    println!("OUT: {:02X?}", test_msg);
                    if let Err(e) = clone_w.write(test_msg) {
                        eprintln!("Write error {}", e)
                    }
                } else {
                    std::thread::sleep(std::time::Duration::from_millis(50));
                }
            }
        },
        Err(e) => {
            eprintln!("Cannot open com port {}", e)
        }
    }
}

Trait Implementations

impl Clone for TTYPort

fn clone(&self) -> TTYPort

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TTYPort

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for TTYPort

fn drop(&mut self)

Executes the destructor for this type.

impl Read for TTYPort

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl SerialPort for TTYPort

fn reconfigure_port(&mut self) -> SerialResult<()>

Reconfigures an open port with the current settings

fn close(self) -> SerialResult<()>

Closes the port

fn set_buffer_size( &mut self, _rx_size: usize, _tx_size: usize, ) -> SerialResult<()>

Sets Tx and Rx buffer size. A sensible value for these is 4096 bytes

fn set_output_flow_control(&self, enable: bool) -> SerialResult<()>

Sets flow control state manually

fn set_data_terminal_ready(&mut self, enable: bool) -> SerialResult<()>

Sets data terminal flag

fn set_request_to_send(&mut self, enable: bool) -> SerialResult<()>

Sets request to send flag

fn set_break_state(&mut self, enable: bool) -> SerialResult<()>

Sets break state flag

fn read_clear_to_send(&self) -> SerialResult<bool>

Reads clear to send flag

fn read_data_set_ready(&self) -> SerialResult<bool>

Reads data set ready flag

fn read_ring_indicator(&self) -> SerialResult<bool>

Reads ring indicator flag

fn read_carrier_detect(&self) -> SerialResult<bool>

Reads carrier detect flag

fn bytes_to_read(&self) -> SerialResult<usize>

Returns number of bytes left to read in serial buffer

fn bytes_to_write(&self) -> SerialResult<usize>

Returns number of bytes left to write in serial buffer

fn get_path(&self) -> String

Gets the path of the port

fn try_clone(&mut self) -> SerialResult<Box<dyn SerialPort>>

Tries to clone the port.

fn clear_input_buffer(&mut self) -> SerialResult<()>

Clears serial input buffer

fn clear_output_buffer(&mut self) -> SerialResult<()>

Clears serial output buffer

impl Write for TTYPort

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.