Struct tokio_pipe::PipeRead

source · [−]

pub struct PipeRead(_);

Expand description

Pipe read

Implementations

source

impl PipeRead

source

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

fd - PipeRead would take the ownership of this fd.

source

pub async fn splice_to(
 &mut self,
 asyncfd_out: &AsyncFd<impl AsRawFd>,
 off_out: Option<&mut off64_t>,
 len: usize,
 has_more_data: bool
) -> Result<usize>

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

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

asyncfd_out - must be have O_NONBLOCK set, otherwise this function might block.
off_out - If it is not None, then it would be updated on success.
has_more_data - If there is more data to be sent to off_out. This is a helpful hint for socket (see also the description of MSG_MORE in send(2), and the description of TCP_CORK in tcp(7)).

Trait Implementations

source

impl AsRawFd for PipeRead

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

source

impl AsyncRead for PipeRead

source

fn poll_read(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf. Read more

source

impl Debug for PipeRead

source

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

Formats the value using the given formatter. Read more

source

impl FromRawFd for PipeRead

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 PipeRead

source

fn into_raw_fd(self) -> RawFd

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

source

impl TryFrom<i32> for PipeRead

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 PipeRead

impl Send for PipeRead

impl Sync for PipeRead

impl Unpin for PipeRead

impl !UnwindSafe for PipeRead

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<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

source

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

Creates a new AsyncRead instance that chains this stream with next. Read more

source

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,

Pulls some bytes from this source into the specified buffer, returning how many bytes were read. Read more

source

fn read_buf(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B> where
Self: Unpin,
B: BufMut,

Pulls some bytes from this source into the specified buffer, advancing the buffer’s internal cursor. Read more

source

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

source

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self> where
Self: Unpin,

Reads an unsigned 8 bit integer from the underlying reader. Read more

source

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self> where
Self: Unpin,

Reads a signed 8 bit integer from the underlying reader. Read more

source

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self> where
Self: Unpin,

Reads an unsigned 16-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self> where
Self: Unpin,

Reads a signed 16-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self> where
Self: Unpin,

Reads an unsigned 32-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self> where
Self: Unpin,

Reads a signed 32-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self> where
Self: Unpin,

Reads an unsigned 64-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self> where
Self: Unpin,

Reads an signed 64-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self> where
Self: Unpin,

Reads an unsigned 128-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self> where
Self: Unpin,

Reads an signed 128-bit integer in big-endian order from the underlying reader. Read more

source

fn read_f32(&'a mut self) -> ReadF32<&'a mut Self> where
Self: Unpin,

Reads an 32-bit floating point type in big-endian order from the underlying reader. Read more

source

fn read_f64(&'a mut self) -> ReadF64<&'a mut Self> where
Self: Unpin,

Reads an 64-bit floating point type in big-endian order from the underlying reader. Read more

source

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self> where
Self: Unpin,

Reads an unsigned 16-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self> where
Self: Unpin,

Reads a signed 16-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self> where
Self: Unpin,

Reads an unsigned 32-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self> where
Self: Unpin,

Reads a signed 32-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self> where
Self: Unpin,

Reads an unsigned 64-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self> where
Self: Unpin,

Reads an signed 64-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self> where
Self: Unpin,

Reads an unsigned 128-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self> where
Self: Unpin,

Reads an signed 128-bit integer in little-endian order from the underlying reader. Read more

source

fn read_f32_le(&'a mut self) -> ReadF32Le<&'a mut Self> where
Self: Unpin,

Reads an 32-bit floating point type in little-endian order from the underlying reader. Read more

source

fn read_f64_le(&'a mut self) -> ReadF64Le<&'a mut Self> where
Self: Unpin,

Reads an 64-bit floating point type in little-endian order from the underlying reader. Read more

source

fn read_to_end(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
 Self: Unpin,

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

source

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,

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

source

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

Creates an adaptor which reads at most limit bytes from it. 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::PipeRead

Implementations

impl PipeRead

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

pub async fn splice_to( &mut self, asyncfd_out: &AsyncFd<impl AsRawFd>, off_out: Option<&mut off64_t>, len: usize, has_more_data: bool) -> Result<usize>

Trait Implementations

impl AsRawFd for PipeRead

fn as_raw_fd(&self) -> RawFd

impl AsyncRead for PipeRead

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>) -> Poll<Result<()>>

impl Debug for PipeRead

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

impl FromRawFd for PipeRead

unsafe fn from_raw_fd(fd: RawFd) -> Self

impl IntoRawFd for PipeRead

fn into_raw_fd(self) -> RawFd

impl TryFrom<i32> for PipeRead

type Error = Error

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

Auto Trait Implementations

impl !RefUnwindSafe for PipeRead

impl Send for PipeRead

impl Sync for PipeRead

impl Unpin for PipeRead

impl !UnwindSafe for PipeRead

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for R where R: AsyncRead + ?Sized,

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

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where Self: Unpin,

fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B> where Self: Unpin, B: BufMut,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where Self: Unpin,

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self> where Self: Unpin,

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self> where Self: Unpin,

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self> where Self: Unpin,

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self> where Self: Unpin,

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self> where Self: Unpin,

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self> where Self: Unpin,

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self> where Self: Unpin,

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self> where Self: Unpin,

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self> where Self: Unpin,

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self> where Self: Unpin,

fn read_f32(&'a mut self) -> ReadF32<&'a mut Self> where Self: Unpin,

fn read_f64(&'a mut self) -> ReadF64<&'a mut Self> where Self: Unpin,

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self> where Self: Unpin,

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self> where Self: Unpin,

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self> where Self: Unpin,

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self> where Self: Unpin,

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self> where Self: Unpin,

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self> where Self: Unpin,

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self> where Self: Unpin,

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self> where Self: Unpin,

fn read_f32_le(&'a mut self) -> ReadF32Le<&'a mut Self> where Self: Unpin,

fn read_f64_le(&'a mut self) -> ReadF64Le<&'a mut Self> where Self: Unpin,

fn read_to_end( &'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self> where Self: Unpin,

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self> where Self: Unpin,

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

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 async fn splice_to(
&mut self,
asyncfd_out: &AsyncFd<impl AsRawFd>,
off_out: Option<&mut off64_t>,
len: usize,
has_more_data: bool
) -> Result<usize>

fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

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

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

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

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,

fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B> where
Self: Unpin,
B: BufMut,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self> where
Self: Unpin,

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self> where
Self: Unpin,

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self> where
Self: Unpin,

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self> where
Self: Unpin,

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self> where
Self: Unpin,

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self> where
Self: Unpin,

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self> where
Self: Unpin,

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self> where
Self: Unpin,

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self> where
Self: Unpin,

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self> where
Self: Unpin,

fn read_f32(&'a mut self) -> ReadF32<&'a mut Self> where
Self: Unpin,

fn read_f64(&'a mut self) -> ReadF64<&'a mut Self> where
Self: Unpin,

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self> where
Self: Unpin,

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self> where
Self: Unpin,

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self> where
Self: Unpin,

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self> where
Self: Unpin,

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self> where
Self: Unpin,

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self> where
Self: Unpin,

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self> where
Self: Unpin,

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self> where
Self: Unpin,

fn read_f32_le(&'a mut self) -> ReadF32Le<&'a mut Self> where
Self: Unpin,

fn read_f64_le(&'a mut self) -> ReadF64Le<&'a mut Self> where
Self: Unpin,

fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self> where
Self: Unpin,

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, 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>,