Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add read_to_end functionality #271

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/fs/file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,35 @@ impl File {
(Ok(()), buf.into_inner())
}

/// Fills a vector with the contents of the file
/// from the given position to the end
///
/// If this function encounters any form of I/O or other error, an error
/// variant will be returned.
/// On error the buffer will contain the partial data that was
/// read up until this point.
pub async fn read_at_to_end(
&self,
mut pos: u64,
mut result: Vec<u8>,
) -> crate::BufResult<(), Vec<u8>> {
let mut buffer = vec![0u8; 4096];

loop {
let (res, buf) = self.read_at(buffer, pos).await;

match res {
Ok(0) => return (Ok(()), result),
Ok(n) => {
buffer = buf;
result.extend_from_slice(&buffer[..n]);
pos += n as u64;
}
Err(err) => return (Err(err), result),
}
}
}

/// Like [`read_at`], but using a pre-mapped buffer
/// registered with [`FixedBufRegistry`].
///
Expand Down
34 changes: 34 additions & 0 deletions tests/fs_file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,23 @@ fn basic_read() {
});
}

#[test]
fn read_exact_buf_too_long() {
tokio_uring::start(async {
let data = HELLO.repeat(1);
let buf = Vec::with_capacity(data.len() * 2);

let mut tempfile = tempfile();
tempfile.write_all(&data).unwrap();

let file = File::open(tempfile.path()).await.unwrap();
let (res, _buf) = file.read_exact_at(buf, 0).await;

assert!(res.is_err());
assert_eq!(res.unwrap_err().kind(), std::io::ErrorKind::UnexpectedEof);
});
}

#[test]
fn basic_read_exact() {
tokio_uring::start(async {
Expand All @@ -51,6 +68,23 @@ fn basic_read_exact() {
});
}

#[test]
fn basic_read_to_end() {
tokio_uring::start(async {
let data = HELLO.repeat(1);

let mut tempfile = tempfile();
tempfile.write_all(&data).unwrap();

let file = File::open(tempfile.path()).await.unwrap();

let buf = vec![];
let (res, buf) = file.read_at_to_end(0, buf).await;
res.unwrap();
assert_eq!(buf, data);
});
}

#[test]
fn basic_write() {
tokio_uring::start(async {
Expand Down