-
Notifications
You must be signed in to change notification settings - Fork 633
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Change copy_into/copy_buf_into to free functions for consistency with…
… the standard library
- Loading branch information
Showing
5 changed files
with
113 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
use futures_core::future::Future; | ||
use futures_core::task::{Context, Poll}; | ||
use futures_io::{AsyncRead, AsyncWrite}; | ||
use std::io; | ||
use std::pin::Pin; | ||
use super::{BufReader, copy_buf, CopyBuf}; | ||
use pin_utils::unsafe_pinned; | ||
|
||
/// Creates a future which copies all the bytes from one object to another. | ||
/// | ||
/// The returned future will copy all the bytes read from this `AsyncRead` into the | ||
/// `writer` specified. This future will only complete once the `reader` has hit | ||
/// EOF and all bytes have been written to and flushed from the `writer` | ||
/// provided. | ||
/// | ||
/// On success the number of bytes is returned. | ||
/// | ||
/// # Examples | ||
/// | ||
/// ``` | ||
/// # futures::executor::block_on(async { | ||
/// use futures::io::{self, AsyncWriteExt, Cursor}; | ||
/// | ||
/// let reader = Cursor::new([1, 2, 3, 4]); | ||
/// let mut writer = Cursor::new(vec![0u8; 5]); | ||
/// | ||
/// let bytes = io::copy(reader, &mut writer).await?; | ||
/// writer.close().await?; | ||
/// | ||
/// assert_eq!(bytes, 4); | ||
/// assert_eq!(writer.into_inner(), [1, 2, 3, 4, 0]); | ||
/// # Ok::<(), Box<dyn std::error::Error>>(()) }).unwrap(); | ||
/// ``` | ||
pub fn copy<R, W>(reader: R, writer: &mut W) -> Copy<'_, R, W> | ||
where | ||
R: AsyncRead, | ||
W: AsyncWrite + Unpin + ?Sized, | ||
{ | ||
Copy { | ||
inner: copy_buf(BufReader::new(reader), writer), | ||
} | ||
} | ||
|
||
/// Future for the [`copy()`] function. | ||
#[derive(Debug)] | ||
#[must_use = "futures do nothing unless you `.await` or poll them"] | ||
pub struct Copy<'a, R, W: ?Sized> { | ||
inner: CopyBuf<'a, BufReader<R>, W>, | ||
} | ||
|
||
impl<'a, R: AsyncRead, W: ?Sized> Unpin for Copy<'a, R, W> where CopyBuf<'a, BufReader<R>, W>: Unpin {} | ||
|
||
impl<'a, R: AsyncRead, W: ?Sized> Copy<'a, R, W> { | ||
unsafe_pinned!(inner: CopyBuf<'a, BufReader<R>, W>); | ||
} | ||
|
||
impl<R: AsyncRead, W: AsyncWrite + Unpin + ?Sized> Future for Copy<'_, R, W> { | ||
type Output = io::Result<u64>; | ||
|
||
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { | ||
self.inner().poll(cx) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters