Struct smithay_client_toolkit::data_device::ReadPipe

pub struct ReadPipe { /* fields omitted */ }

A file descriptor that can only be read from

If the calloop cargo feature is enabled, this can be used as an EventSource in a calloop event loop.

Trait Implementations

impl AsRawFd for ReadPipe

pub fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl EventSource for ReadPipe

type Event = ()

The type of events generated by your source.

type Metadata = File

Some metadata of your event source

type Ret = ()

The return type of the user callback

pub fn process_events<F>(
    &mut self,
    readiness: Readiness,
    token: Token,
    callback: F
) -> Result<()> where
    F: FnMut((), &mut File), 

Process any relevant events

pub fn register(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Register yourself to this poll instance

pub fn reregister(&mut self, poll: &mut Poll, token: Token) -> Result<()>

Re-register your file descriptors

pub fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

impl FromRawFd for ReadPipe

pub unsafe fn from_raw_fd(fd: RawFd) -> ReadPipe

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for ReadPipe

pub fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for ReadPipe

pub 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.

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

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

pub 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.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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