## Sender

# Struct Sender

Source

    pub struct Sender { /* private fields */ }

Expand description

Sending end of an Unix pipe.

See `new` for documentation, including examples.

## Implementations§

Source§

### impl Sender

Source

#### pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Set the `Sender` into or out of non-blocking mode.

Source

#### pub fn try_io<F, T>(&self, f: F) -> Result<T>
where F: FnOnce() -> Result<T>,

Execute an I/O operation ensuring that the socket receives more events if it hits a `WouldBlock` error.

##### §Notes

This method is required to be called for all I/O operations to ensure the user will receive events once the socket is ready again after returning a `WouldBlock` error.

##### §Examples

    use std::io;
    use std::os::fd::AsRawFd;
    use mio::unix::pipe;

    let (sender, receiver) = pipe::new()?;

    // Wait until the sender is writable...

    // Write to the sender using a direct libc call, of course the
    // `io::Write` implementation would be easier to use.
    let buf = b"hello";
    let n = sender.try_io(|| {
        let buf_ptr = &buf as *const _ as *const _;
        let res = unsafe { libc::write(sender.as_raw_fd(), buf_ptr, buf.len()) };
        if res != -1 {
            Ok(res as usize)
        } else {
            // If EAGAIN or EWOULDBLOCK is set by libc::write, the closure
            // should return `WouldBlock` error.
            Err(io::Error::last_os_error())
        }
    })?;
    eprintln!("write {} bytes", n);

    // Wait until the receiver is readable...

    // Read from the receiver using a direct libc call, of course the
    // `io::Read` implementation would be easier to use.
    let mut buf = [0; 512];
    let n = receiver.try_io(|| {
        let buf_ptr = &mut buf as *mut _ as *mut _;
        let res = unsafe { libc::read(receiver.as_raw_fd(), buf_ptr, buf.len()) };
        if res != -1 {
            Ok(res as usize)
        } else {
            // If EAGAIN or EWOULDBLOCK is set by libc::read, the closure
            // should return `WouldBlock` error.
            Err(io::Error::last_os_error())
        }
    })?;
    eprintln!("read {} bytes", n);

## Trait Implementations§

Source§

### impl AsFd for Sender

Source§

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

Borrows the file descriptor. Read more
Source§

### impl AsRawFd for Sender

Source§

#### fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
Source§

### impl Debug for Sender

Source§

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

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

### impl From<ChildStdin> for Sender

#### §Notes

The underlying pipe is not set to non-blocking.

Source§

#### fn from(stdin: ChildStdin) -> Sender ⓘ

Converts to this type from the input type.
Source§

### impl From<OwnedFd> for Sender

Source§

#### fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.
Source§

### impl From<Sender> for OwnedFd

Source§

#### fn from(sender: Sender) -> Self

Converts to this type from the input type.
Source§

### impl FromRawFd for Sender

Source§

#### unsafe fn from_raw_fd(fd: RawFd) -> Sender ⓘ

Constructs a new instance of `Self` from the given raw file descriptor. Read more
Source§

### impl IntoRawFd for Sender

Source§

#### fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more
Source§

### impl Source for Sender

Source§

#### fn register( &mut self, registry: &Registry, token: Token, interests: Interest, ) -> Result<()>

Register `self` with the given `Registry` instance. Read more
Source§

#### fn reregister( &mut self, registry: &Registry, token: Token, interests: Interest, ) -> Result<()>

Re-register `self` with the given `Registry` instance. Read more
Source§

#### fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister `self` from the given `Registry` instance. Read more
Source§

### impl Write for &Sender

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Like `write`, except that it writes from a slice of buffers. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector`)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

#### 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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

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

Creates a “by reference” adapter for this instance of `Write`. Read more
Source§

### impl Write for Sender

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Like `write`, except that it writes from a slice of buffers. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector`)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

#### 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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

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

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

## Auto Trait Implementations§

§

### impl !Freeze for Sender

§

### impl RefUnwindSafe for Sender

§

### impl Send for Sender

§

### impl Sync for Sender

§

### impl Unpin for Sender

§

### impl UnwindSafe for Sender

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