Struct tokio::io::BufStream [−][src]
Wraps a type that is AsyncWrite
and AsyncRead
, and buffers its input and output.
It can be excessively inefficient to work directly with something that implements AsyncWrite
and AsyncRead
. For example, every write
, however small, has to traverse the syscall
interface, and similarly, every read has to do the same. The BufWriter
and BufReader
types aid with these problems respectively, but do so in only one direction. BufStream
wraps
one in the other so that both directions are buffered. See their documentation for details.
Implementations
impl<RW: AsyncRead + AsyncWrite> BufStream<RW>
[src]
pub fn new(stream: RW) -> BufStream<RW>
[src]
Wraps a type in both BufWriter
and BufReader
.
See the documentation for those types and BufStream
for details.
pub fn with_capacity(
reader_capacity: usize,
writer_capacity: usize,
stream: RW
) -> BufStream<RW>
[src]
reader_capacity: usize,
writer_capacity: usize,
stream: RW
) -> BufStream<RW>
Creates a BufStream
with the specified BufReader
capacity and BufWriter
capacity.
See the documentation for those types and BufStream
for details.
pub fn get_ref(&self) -> &RWⓘ
[src]
Gets a reference to the underlying I/O object.
It is inadvisable to directly read from the underlying I/O object.
pub fn get_mut(&mut self) -> &mut RWⓘ
[src]
Gets a mutable reference to the underlying I/O object.
It is inadvisable to directly read from the underlying I/O object.
pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut RW>ⓘ
[src]
Gets a pinned mutable reference to the underlying I/O object.
It is inadvisable to directly read from the underlying I/O object.
pub fn into_inner(self) -> RW
[src]
Consumes this BufStream
, returning the underlying I/O object.
Note that any leftover data in the internal buffer is lost.
Trait Implementations
impl<RW: AsyncRead + AsyncWrite> AsyncBufRead for BufStream<RW>
[src]
fn poll_fill_buf(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
fn consume(self: Pin<&mut Self>, amt: usize)
[src]
impl<RW: AsyncRead + AsyncWrite> AsyncRead for BufStream<RW>
[src]
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
unsafe fn prepare_uninitialized_buffer(
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool
[src]
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool
fn poll_read_buf<B: BufMut>(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>> where
Self: Sized,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>> where
Self: Sized,
impl<RW: AsyncRead + AsyncWrite> AsyncWrite for BufStream<RW>
[src]
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
fn poll_write_buf<B: Buf>(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize, Error>> where
Self: Sized,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize, Error>> where
Self: Sized,
impl<RW: Debug> Debug for BufStream<RW>
[src]
impl<RW> From<BufReader<BufWriter<RW>>> for BufStream<RW>
[src]
impl<RW> From<BufWriter<BufReader<RW>>> for BufStream<RW>
[src]
impl<'__pin, RW> Unpin for BufStream<RW> where
__Origin<'__pin, RW>: Unpin,
[src]
__Origin<'__pin, RW>: Unpin,
Auto Trait Implementations
impl<RW> RefUnwindSafe for BufStream<RW> where
RW: RefUnwindSafe,
RW: RefUnwindSafe,
impl<RW> Send for BufStream<RW> where
RW: Send,
RW: Send,
impl<RW> Sync for BufStream<RW> where
RW: Sync,
RW: Sync,
impl<RW> UnwindSafe for BufStream<RW> where
RW: UnwindSafe,
RW: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,