Struct char_device::CharDevice

#[repr(transparent)]
pub struct CharDevice(_);

An unbuffered character device.

This is a wrapper around std::fs::File which is intended for use with character device “files” such as “/dev/tty”.

Implementations

impl CharDevice

pub fn new<Filelike: IntoFilelike + Read + Write>(
    filelike: Filelike
) -> Result<Self>

Construct a new CharDevice. Fail if the given handle isn’t a valid handle for a character device, or it can’t be determined.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Construct a new CharDevice from the given filename. Fail if the given handle isn’t a valid handle for a character device, or it can’t be determined.

pub unsafe fn new_unchecked<Filelike: IntoFilelike>(filelike: Filelike) -> Self

Construct a new CharDevice.

Safety

Doesn’t check that the handle is valid or a character device.

pub fn null() -> Result<Self>

Construct a new CharDevice which discards writes and reads nothing.

This is “/dev/null” on Posix-ish platforms and “nul” on Windows.

pub fn try_clone(&self) -> Result<Self>

Creates a new independently owned handle to the underlying device.

pub fn num_ready_bytes(&self) -> Result<u64>

Return the number of bytes which are ready to be read immediately.

Trait Implementations

impl AsFd for CharDevice

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for CharDevice

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsRawReadWriteFd for CharDevice

fn as_raw_read_fd(&self) -> RawFd

Extracts the raw file descriptor for reading.

fn as_raw_write_fd(&self) -> RawFd

Extracts the raw file descriptor for writing.

impl AsReadWriteFd for CharDevice

fn as_read_fd(&self) -> BorrowedFd<'_>

Extracts the file descriptor for reading.

fn as_write_fd(&self) -> BorrowedFd<'_>

Extracts the file descriptor for writing.

impl Debug for CharDevice

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

Formats the value using the given formatter.

impl From<CharDevice> for OwnedFd

fn from(char_device: CharDevice) -> OwnedFd

Converts to this type from the input type.

impl IntoRawFd for CharDevice

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for CharDevice

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>

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>

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

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

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

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

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    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 Write for CharDevice

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

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

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

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

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

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

Attempts to write an entire buffer into this writer.

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

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

Attempts to write multiple buffers into this writer.

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

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

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

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