termios

Struct Termios

Source
pub struct Termios { /* private fields */ }
Expand description

Unix terminal I/O control structure.

The Termios structure is a thin wrapper for the OS-specific termios struct. The only safe way to obtain a Termios structure is to fill one from a file descriptor with Termios::from_fd(), after which it can be treated just like the POSIX termios struct. It provides access to the standard fields of the termios struct (c_iflag, c_oflag, c_cflag, c_lflag, and c_cc) through the Deref and DerefMut traits.

§Example

The following is an example of how one might setup a file descriptor for a serial port:

use std::io;
use std::os::unix::io::RawFd;

fn setup_serial(fd: RawFd) -> io::Result<()> {
    use termios::*;

    let mut termios = try!(Termios::from_fd(fd));

    termios.c_cflag |= CREAD | CLOCAL;
    termios.c_lflag &= !(ICANON | ECHO | ECHOE | ECHOK | ECHONL | ISIG | IEXTEN);
    termios.c_oflag &= !OPOST;
    termios.c_iflag &= !(INLCR | IGNCR | ICRNL | IGNBRK);

    termios.c_cc[VMIN] = 0;
    termios.c_cc[VTIME] = 0;

    try!(cfsetspeed(&mut termios, B9600));
    try!(tcsetattr(fd, TCSANOW, &mut termios));

    Ok(())
}

Implementations§

Source§

impl Termios

Source

pub fn from_fd(fd: RawFd) -> Result<Self>

Creates a Termios structure based on the current settings of a file descriptor.

fd must be an open file descriptor for a terminal device.

Trait Implementations§

Source§

impl Clone for Termios

Source§

fn clone(&self) -> Termios

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Termios

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for Termios

Source§

type Target = termios

The resulting type after dereferencing.
Source§

fn deref(&self) -> &termios

Dereferences the value.
Source§

impl DerefMut for Termios

Source§

fn deref_mut(&mut self) -> &mut termios

Mutably dereferences the value.
Source§

impl PartialEq for Termios

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for Termios

Source§

impl Eq for Termios

Source§

impl StructuralPartialEq for Termios

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.