Struct PortInfo

pub struct PortInfo { /* private fields */ }

Information on a listed serial port

Implementations

impl PortInfo

pub fn get_port(&self) -> &str

Gets port name

Examples found in repository

examples/port_list.rs (line 29)

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)
        }
    }
}

pub fn get_hwid(&self) -> &str

Gets port system hardware-ID

pub fn get_pid(&self) -> u16

Gets port devices’ ProductID

pub fn get_vid(&self) -> u16

Gets port devices’ VendorID

pub fn get_manufacturer(&self) -> &str

Gets port devices’ manufacturer

Examples found in repository

examples/port_list.rs (line 31)

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)
        }
    }
}

pub fn get_desc(&self) -> &str

Gets port devices’ description

Examples found in repository

examples/port_list.rs (line 30)

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 PortInfo

fn clone(&self) -> PortInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortInfo

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

Formats the value using the given formatter.

impl Default for PortInfo

fn default() -> PortInfo

Returns the “default value” for a type.

impl Ord for PortInfo

fn cmp(&self, other: &PortInfo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PortInfo

fn eq(&self, other: &PortInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PortInfo

fn partial_cmp(&self, other: &PortInfo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PortInfo

impl StructuralPartialEq for PortInfo