Struct WritePipe

pub struct WritePipe { /* private fields */ }

Available on crate feature wayland and Linux only.

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

Trait Implementations

impl AsFd for WritePipe

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

Borrows the file descriptor.

impl AsRawFd for WritePipe

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Debug for WritePipe

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

Formats the value using the given formatter.

impl EventSource for WritePipe

type Event = ()

The type of events generated by your source.

type Error = Error

The error type returned from process_events() (not the user callback!).

type Metadata = NoIoDrop<File>

Some metadata of your event source

type Ret = PostAction

The return type of the user callback

fn process_events<F>( &mut self, readiness: Readiness, token: Token, callback: F, ) -> Result<PostAction, Error>

where F: FnMut((), &mut NoIoDrop<File>) -> <WritePipe as EventSource>::Ret,

Process any relevant events

fn register( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<(), Error>

Register yourself to this poll instance

fn reregister( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<(), Error>

Re-register your file descriptors

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

Unregister your file descriptors

const NEEDS_EXTRA_LIFECYCLE_EVENTS: bool = false

Whether this source needs to be sent the EventSource::before_sleep and EventSource::before_handle_events notifications. These are opt-in because they require more expensive checks, and almost all sources will not need these notifications

fn before_sleep(&mut self) -> Result<Option<(Readiness, Token)>, Error>

Notification that a single poll is about to begin

fn before_handle_events(&mut self, events: EventIterator<'_>)

Notification that polling is complete, and EventSource::process_events will be called with the given events for this source. The iterator may be empty, which indicates that no events were generated for this source

impl From<OwnedFd> for WritePipe

fn from(owned: OwnedFd) -> WritePipe

Converts to this type from the input type.

impl FromRawFd for WritePipe

unsafe fn from_raw_fd(fd: i32) -> WritePipe

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

impl IntoRawFd for WritePipe

fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor.

impl Write for WritePipe

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

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

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

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.