Struct tokio_pipe::PipeWrite

source · [−]

pub struct PipeWrite(_);

Expand description

Pipe write

Implementations

source

impl PipeWrite

source

pub fn from_raw_fd_checked(fd: RawFd) -> Result<Self, Error>

fd - PipeWrite would take the ownership of this fd.

source

impl PipeWrite

source

pub fn poll_write_atomic(
 self: Pin<&Self>,
 cx: &mut Context<'_>,
 buf: AtomicWriteBuffer<'_>
) -> Poll<Result<usize, Error>>

Write buf atomically to the pipe, using guarantees provided in POSIX.1

source

pub fn poll_write_vectored_atomic(
 self: Pin<&Self>,
 cx: &mut Context<'_>,
 bufs: AtomicWriteIoSlices<'_, '_>
) -> Poll<Result<usize, Error>>

source

pub async fn splice_from(
 &mut self,
 asyncfd_in: &mut AsyncFd<impl AsRawFd>,
 off_in: Option<&mut off64_t>,
 len: usize
) -> Result<usize>

Moves data between fd and pipe without copying between kernel address space and user address space.

It transfers up to len bytes of data from asyncfd_in to self.

asyncfd_in - must be have O_NONBLOCK set, otherwise this function might block. There must not be other reader for that fd (or its duplicates).
off_in - If it is not None, then it would be updated on success.

Trait Implementations

source

impl AsRawFd for PipeWrite

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl AsyncWrite for PipeWrite

source

fn poll_write(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object. Read more

source

fn poll_flush(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination. Read more

source

fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down. Read more

source

fn poll_write_vectored(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers. Read more

source

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation. Read more

source

impl Debug for PipeWrite

source

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

Formats the value using the given formatter. Read more

source

impl FromRawFd for PipeWrite

source

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

source

impl IntoRawFd for PipeWrite

source

fn into_raw_fd(self) -> RawFd

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

source

impl TryFrom<i32> for PipeWrite

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(fd: RawFd) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for PipeWrite

impl Send for PipeWrite

impl Sync for PipeWrite

impl Unpin for PipeWrite

impl !UnwindSafe for PipeWrite

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<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

source

fn write(&'a mut self, src: &'a [u8]) -> Write<'a, Self> where
Self: Unpin,

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

source

fn write_vectored(
 &'a mut self,
 bufs: &'a [IoSlice<'b>]
) -> WriteVectored<'a, 'b, Self> where
 Self: Unpin,

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

source

fn write_buf(&'a mut self, src: &'a mut B) -> WriteBuf<'a, Self, B> where
Self: Unpin,
B: Buf,

Writes a buffer into this writer, advancing the buffer’s internal cursor. Read more

source

fn write_all_buf(&'a mut self, src: &'a mut B) -> WriteAllBuf<'a, Self, B> where
Self: Unpin,
B: Buf,

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

source

fn write_all(&'a mut self, src: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,

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

source

fn write_u8(&'a mut self, n: u8) -> WriteU8<&'a mut Self> where
Self: Unpin,

Writes an unsigned 8-bit integer to the underlying writer. Read more

source

fn write_i8(&'a mut self, n: i8) -> WriteI8<&'a mut Self> where
Self: Unpin,

Writes an unsigned 8-bit integer to the underlying writer. Read more

source

fn write_u16(&'a mut self, n: u16) -> WriteU16<&'a mut Self> where
Self: Unpin,

Writes an unsigned 16-bit integer in big-endian order to the underlying writer. Read more

source

fn write_i16(&'a mut self, n: i16) -> WriteI16<&'a mut Self> where
Self: Unpin,

Writes a signed 16-bit integer in big-endian order to the underlying writer. Read more

source

fn write_u32(&'a mut self, n: u32) -> WriteU32<&'a mut Self> where
Self: Unpin,

Writes an unsigned 32-bit integer in big-endian order to the underlying writer. Read more

source

fn write_i32(&'a mut self, n: i32) -> WriteI32<&'a mut Self> where
Self: Unpin,

Writes a signed 32-bit integer in big-endian order to the underlying writer. Read more

source

fn write_u64(&'a mut self, n: u64) -> WriteU64<&'a mut Self> where
Self: Unpin,

Writes an unsigned 64-bit integer in big-endian order to the underlying writer. Read more

source

fn write_i64(&'a mut self, n: i64) -> WriteI64<&'a mut Self> where
Self: Unpin,

Writes an signed 64-bit integer in big-endian order to the underlying writer. Read more

source

fn write_u128(&'a mut self, n: u128) -> WriteU128<&'a mut Self> where
Self: Unpin,

Writes an unsigned 128-bit integer in big-endian order to the underlying writer. Read more

source

fn write_i128(&'a mut self, n: i128) -> WriteI128<&'a mut Self> where
Self: Unpin,

Writes an signed 128-bit integer in big-endian order to the underlying writer. Read more

source

fn write_f32(&'a mut self, n: f32) -> WriteF32<&'a mut Self> where
Self: Unpin,

Writes an 32-bit floating point type in big-endian order to the underlying writer. Read more

source

fn write_f64(&'a mut self, n: f64) -> WriteF64<&'a mut Self> where
Self: Unpin,

Writes an 64-bit floating point type in big-endian order to the underlying writer. Read more

source

fn write_u16_le(&'a mut self, n: u16) -> WriteU16Le<&'a mut Self> where
Self: Unpin,

Writes an unsigned 16-bit integer in little-endian order to the underlying writer. Read more

source

fn write_i16_le(&'a mut self, n: i16) -> WriteI16Le<&'a mut Self> where
Self: Unpin,

Writes a signed 16-bit integer in little-endian order to the underlying writer. Read more

source

fn write_u32_le(&'a mut self, n: u32) -> WriteU32Le<&'a mut Self> where
Self: Unpin,

Writes an unsigned 32-bit integer in little-endian order to the underlying writer. Read more

source

fn write_i32_le(&'a mut self, n: i32) -> WriteI32Le<&'a mut Self> where
Self: Unpin,

Writes a signed 32-bit integer in little-endian order to the underlying writer. Read more

source

fn write_u64_le(&'a mut self, n: u64) -> WriteU64Le<&'a mut Self> where
Self: Unpin,

Writes an unsigned 64-bit integer in little-endian order to the underlying writer. Read more

source

fn write_i64_le(&'a mut self, n: i64) -> WriteI64Le<&'a mut Self> where
Self: Unpin,

Writes an signed 64-bit integer in little-endian order to the underlying writer. Read more

source

fn write_u128_le(&'a mut self, n: u128) -> WriteU128Le<&'a mut Self> where
Self: Unpin,

Writes an unsigned 128-bit integer in little-endian order to the underlying writer. Read more

source

fn write_i128_le(&'a mut self, n: i128) -> WriteI128Le<&'a mut Self> where
Self: Unpin,

Writes an signed 128-bit integer in little-endian order to the underlying writer. Read more

source

fn write_f32_le(&'a mut self, n: f32) -> WriteF32Le<&'a mut Self> where
Self: Unpin,

Writes an 32-bit floating point type in little-endian order to the underlying writer. Read more

source

fn write_f64_le(&'a mut self, n: f64) -> WriteF64Le<&'a mut Self> where
Self: Unpin,

Writes an 64-bit floating point type in little-endian order to the underlying writer. Read more

source

fn flush(&mut self) -> Flush<'_, Self> where
Self: Unpin,

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

source

fn shutdown(&mut self) -> Shutdown<'_, Self> where
Self: Unpin,

Shuts down the output stream, ensuring that the value can be dropped cleanly. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct tokio_pipe::PipeWrite

Implementations

impl PipeWrite

pub fn from_raw_fd_checked(fd: RawFd) -> Result<Self, Error>

impl PipeWrite

pub fn poll_write_atomic( self: Pin<&Self>, cx: &mut Context<'_>, buf: AtomicWriteBuffer<'_>) -> Poll<Result<usize, Error>>

pub fn poll_write_vectored_atomic( self: Pin<&Self>, cx: &mut Context<'_>, bufs: AtomicWriteIoSlices<'_, '_>) -> Poll<Result<usize, Error>>

pub async fn splice_from( &mut self, asyncfd_in: &mut AsyncFd<impl AsRawFd>, off_in: Option<&mut off64_t>, len: usize) -> Result<usize>

Trait Implementations

impl AsRawFd for PipeWrite

fn as_raw_fd(&self) -> RawFd

impl AsyncWrite for PipeWrite

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize, Error>>

fn poll_flush( self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<(), Error>>

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Error>>

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>]) -> Poll<Result<usize, Error>>

fn is_write_vectored(&self) -> bool

impl Debug for PipeWrite

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

impl FromRawFd for PipeWrite

unsafe fn from_raw_fd(fd: RawFd) -> Self

impl IntoRawFd for PipeWrite

fn into_raw_fd(self) -> RawFd

impl TryFrom<i32> for PipeWrite

type Error = Error

fn try_from(fd: RawFd) -> Result<Self, Self::Error>

Auto Trait Implementations

impl !RefUnwindSafe for PipeWrite

impl Send for PipeWrite

impl Sync for PipeWrite

impl Unpin for PipeWrite

impl !UnwindSafe for PipeWrite

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<W> AsyncWriteExt for W where W: AsyncWrite + ?Sized,

fn write(&'a mut self, src: &'a [u8]) -> Write<'a, Self> where Self: Unpin,

fn write_vectored( &'a mut self, bufs: &'a [IoSlice<'b>]) -> WriteVectored<'a, 'b, Self> where Self: Unpin,

fn write_buf<B>(&'a mut self, src: &'a mut B) -> WriteBuf<'a, Self, B> where Self: Unpin, B: Buf,

fn write_all_buf<B>(&'a mut self, src: &'a mut B) -> WriteAllBuf<'a, Self, B> where Self: Unpin, B: Buf,

fn write_all(&'a mut self, src: &'a [u8]) -> WriteAll<'a, Self> where Self: Unpin,

fn write_u8(&'a mut self, n: u8) -> WriteU8<&'a mut Self> where Self: Unpin,

fn write_i8(&'a mut self, n: i8) -> WriteI8<&'a mut Self> where Self: Unpin,

fn write_u16(&'a mut self, n: u16) -> WriteU16<&'a mut Self> where Self: Unpin,

fn write_i16(&'a mut self, n: i16) -> WriteI16<&'a mut Self> where Self: Unpin,

fn write_u32(&'a mut self, n: u32) -> WriteU32<&'a mut Self> where Self: Unpin,

fn write_i32(&'a mut self, n: i32) -> WriteI32<&'a mut Self> where Self: Unpin,

fn write_u64(&'a mut self, n: u64) -> WriteU64<&'a mut Self> where Self: Unpin,

fn write_i64(&'a mut self, n: i64) -> WriteI64<&'a mut Self> where Self: Unpin,

fn write_u128(&'a mut self, n: u128) -> WriteU128<&'a mut Self> where Self: Unpin,

fn write_i128(&'a mut self, n: i128) -> WriteI128<&'a mut Self> where Self: Unpin,

fn write_f32(&'a mut self, n: f32) -> WriteF32<&'a mut Self> where Self: Unpin,

fn write_f64(&'a mut self, n: f64) -> WriteF64<&'a mut Self> where Self: Unpin,

fn write_u16_le(&'a mut self, n: u16) -> WriteU16Le<&'a mut Self> where Self: Unpin,

fn write_i16_le(&'a mut self, n: i16) -> WriteI16Le<&'a mut Self> where Self: Unpin,

fn write_u32_le(&'a mut self, n: u32) -> WriteU32Le<&'a mut Self> where Self: Unpin,

fn write_i32_le(&'a mut self, n: i32) -> WriteI32Le<&'a mut Self> where Self: Unpin,

fn write_u64_le(&'a mut self, n: u64) -> WriteU64Le<&'a mut Self> where Self: Unpin,

fn write_i64_le(&'a mut self, n: i64) -> WriteI64Le<&'a mut Self> where Self: Unpin,

fn write_u128_le(&'a mut self, n: u128) -> WriteU128Le<&'a mut Self> where Self: Unpin,

fn write_i128_le(&'a mut self, n: i128) -> WriteI128Le<&'a mut Self> where Self: Unpin,

fn write_f32_le(&'a mut self, n: f32) -> WriteF32Le<&'a mut Self> where Self: Unpin,

fn write_f64_le(&'a mut self, n: f64) -> WriteF64Le<&'a mut Self> where Self: Unpin,

fn flush(&mut self) -> Flush<'_, Self> where Self: Unpin,

fn shutdown(&mut self) -> Shutdown<'_, Self> where Self: Unpin,

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn poll_write_atomic(
self: Pin<&Self>,
cx: &mut Context<'_>,
buf: AtomicWriteBuffer<'_>
) -> Poll<Result<usize, Error>>

pub fn poll_write_vectored_atomic(
self: Pin<&Self>,
cx: &mut Context<'_>,
bufs: AtomicWriteIoSlices<'_, '_>
) -> Poll<Result<usize, Error>>

pub async fn splice_from(
&mut self,
asyncfd_in: &mut AsyncFd<impl AsRawFd>,
off_in: Option<&mut off64_t>,
len: usize
) -> Result<usize>

fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize, Error>>

fn poll_flush(
self: Pin<&mut Self>,
_: &mut Context<'_>
) -> Poll<Result<(), Error>>

fn poll_shutdown(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

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

impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,

fn write(&'a mut self, src: &'a [u8]) -> Write<'a, Self> where
Self: Unpin,

fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'b>]
) -> WriteVectored<'a, 'b, Self> where
Self: Unpin,

fn write_buf<B>(&'a mut self, src: &'a mut B) -> WriteBuf<'a, Self, B> where
Self: Unpin,
B: Buf,

fn write_all_buf<B>(&'a mut self, src: &'a mut B) -> WriteAllBuf<'a, Self, B> where
Self: Unpin,
B: Buf,

fn write_all(&'a mut self, src: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,

fn write_u8(&'a mut self, n: u8) -> WriteU8<&'a mut Self> where
Self: Unpin,

fn write_i8(&'a mut self, n: i8) -> WriteI8<&'a mut Self> where
Self: Unpin,

fn write_u16(&'a mut self, n: u16) -> WriteU16<&'a mut Self> where
Self: Unpin,

fn write_i16(&'a mut self, n: i16) -> WriteI16<&'a mut Self> where
Self: Unpin,

fn write_u32(&'a mut self, n: u32) -> WriteU32<&'a mut Self> where
Self: Unpin,

fn write_i32(&'a mut self, n: i32) -> WriteI32<&'a mut Self> where
Self: Unpin,

fn write_u64(&'a mut self, n: u64) -> WriteU64<&'a mut Self> where
Self: Unpin,

fn write_i64(&'a mut self, n: i64) -> WriteI64<&'a mut Self> where
Self: Unpin,

fn write_u128(&'a mut self, n: u128) -> WriteU128<&'a mut Self> where
Self: Unpin,

fn write_i128(&'a mut self, n: i128) -> WriteI128<&'a mut Self> where
Self: Unpin,

fn write_f32(&'a mut self, n: f32) -> WriteF32<&'a mut Self> where
Self: Unpin,

fn write_f64(&'a mut self, n: f64) -> WriteF64<&'a mut Self> where
Self: Unpin,

fn write_u16_le(&'a mut self, n: u16) -> WriteU16Le<&'a mut Self> where
Self: Unpin,

fn write_i16_le(&'a mut self, n: i16) -> WriteI16Le<&'a mut Self> where
Self: Unpin,

fn write_u32_le(&'a mut self, n: u32) -> WriteU32Le<&'a mut Self> where
Self: Unpin,

fn write_i32_le(&'a mut self, n: i32) -> WriteI32Le<&'a mut Self> where
Self: Unpin,

fn write_u64_le(&'a mut self, n: u64) -> WriteU64Le<&'a mut Self> where
Self: Unpin,

fn write_i64_le(&'a mut self, n: i64) -> WriteI64Le<&'a mut Self> where
Self: Unpin,

fn write_u128_le(&'a mut self, n: u128) -> WriteU128Le<&'a mut Self> where
Self: Unpin,

fn write_i128_le(&'a mut self, n: i128) -> WriteI128Le<&'a mut Self> where
Self: Unpin,

fn write_f32_le(&'a mut self, n: f32) -> WriteF32Le<&'a mut Self> where
Self: Unpin,

fn write_f64_le(&'a mut self, n: f64) -> WriteF64Le<&'a mut Self> where
Self: Unpin,

fn flush(&mut self) -> Flush<'_, Self> where
Self: Unpin,

fn shutdown(&mut self) -> Shutdown<'_, Self> where
Self: Unpin,

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

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

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

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

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