1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
#[cfg(feature = "allocator_api")]
use std::alloc::Allocator;
use compio_buf::{t_alloc, BufResult, IntoInner, IoBuf, IoBufMut, IoVectoredBufMut};
use crate::{util::Take, AsyncRead, AsyncReadAt, IoResult};
/// Shared code for read a scalar value from the underlying reader.
macro_rules! read_scalar {
($t:ty, $be:ident, $le:ident) => {
::paste::paste! {
#[doc = concat!("Read a big endian `", stringify!($t), "` from the underlying reader.")]
async fn [< read_ $t >](&mut self) -> IoResult<$t> {
use ::compio_buf::{arrayvec::ArrayVec, BufResult};
const LEN: usize = ::std::mem::size_of::<$t>();
let BufResult(res, buf) = self.read_exact(ArrayVec::<u8, LEN>::new()).await;
res?;
// Safety: We just checked that the buffer is the correct size
Ok($t::$be(unsafe { buf.into_inner_unchecked() }))
}
#[doc = concat!("Read a little endian `", stringify!($t), "` from the underlying reader.")]
async fn [< read_ $t _le >](&mut self) -> IoResult<$t> {
use ::compio_buf::{arrayvec::ArrayVec, BufResult};
const LEN: usize = ::std::mem::size_of::<$t>();
let BufResult(res, buf) = self.read_exact(ArrayVec::<u8, LEN>::new()).await;
res?;
// Safety: We just checked that the buffer is the correct size
Ok($t::$le(unsafe { buf.into_inner_unchecked() }))
}
}
};
}
/// Shared code for loop reading until reaching a certain length.
macro_rules! loop_read_exact {
($buf:ident, $len:expr, $tracker:ident,loop $read_expr:expr) => {
let mut $tracker = 0;
let len = $len;
while $tracker < len {
match $read_expr.await.into_inner() {
BufResult(Ok(0), buf) => {
return BufResult(
Err(::std::io::Error::new(
::std::io::ErrorKind::UnexpectedEof,
"failed to fill whole buffer",
)),
buf,
);
}
BufResult(Ok(n), buf) => {
$tracker += n;
$buf = buf;
}
BufResult(Err(ref e), buf) if e.kind() == ::std::io::ErrorKind::Interrupted => {
$buf = buf;
}
BufResult(Err(e), buf) => return BufResult(Err(e), buf),
}
}
return BufResult(Ok(()), $buf)
};
}
macro_rules! loop_read_vectored {
($buf:ident, $tracker:ident : $tracker_ty:ty, $iter:ident,loop $read_expr:expr) => {{
use ::compio_buf::OwnedIterator;
let mut $iter = match $buf.owned_iter() {
Ok(buf) => buf,
Err(buf) => return BufResult(Ok(()), buf),
};
let mut $tracker: $tracker_ty = 0;
loop {
let len = $iter.buf_capacity();
if len == 0 {
continue;
}
match $read_expr.await {
BufResult(Ok(()), ret) => {
$iter = ret;
$tracker += len as $tracker_ty;
}
BufResult(Err(e), $iter) => return BufResult(Err(e), $iter.into_inner()),
};
match $iter.next() {
Ok(next) => $iter = next,
Err(buf) => return BufResult(Ok(()), buf),
}
}
}};
(
$buf:ident,
$len:ident,
$tracker:ident :
$tracker_ty:ty,
$res:ident,
$iter:ident,loop
$read_expr:expr,break
$judge_expr:expr
) => {{
use ::compio_buf::OwnedIterator;
let mut $iter = match $buf.owned_iter() {
Ok(buf) => buf,
Err(buf) => return BufResult(Ok(0), buf),
};
let mut $tracker: $tracker_ty = 0;
loop {
let $len = $iter.buf_capacity();
if $len == 0 {
continue;
}
match $read_expr.await {
BufResult(Ok($res), ret) => {
$iter = ret;
$tracker += $res as $tracker_ty;
if let Some(res) = $judge_expr {
return BufResult(res, $iter.into_inner());
}
}
BufResult(Err(e), $iter) => return BufResult(Err(e), $iter.into_inner()),
};
match $iter.next() {
Ok(next) => $iter = next,
Err(buf) => return BufResult(Ok($tracker as usize), buf),
}
}
}};
}
macro_rules! loop_read_to_end {
($buf:ident, $tracker:ident : $tracker_ty:ty,loop $read_expr:expr) => {{
let mut $tracker: $tracker_ty = 0;
loop {
if $buf.len() == $buf.capacity() {
$buf.reserve(32);
}
match $read_expr.await.into_inner() {
BufResult(Ok(0), buf) => {
$buf = buf;
break;
}
BufResult(Ok(read), buf) => {
$tracker += read as $tracker_ty;
$buf = buf;
}
BufResult(Err(ref e), buf) if e.kind() == ::std::io::ErrorKind::Interrupted => {
$buf = buf
}
res => return res,
}
}
BufResult(Ok($tracker as usize), $buf)
}};
}
/// Implemented as an extension trait, adding utility methods to all
/// [`AsyncRead`] types. Callers will tend to import this trait instead of
/// [`AsyncRead`].
pub trait AsyncReadExt: AsyncRead {
/// Creates a "by reference" adaptor for this instance of [`AsyncRead`].
///
/// The returned adapter also implements [`AsyncRead`] and will simply
/// borrow this current reader.
fn by_ref(&mut self) -> &mut Self
where
Self: Sized,
{
self
}
/// Read the exact number of bytes required to fill the buf.
async fn read_exact<T: IoBufMut>(&mut self, mut buf: T) -> BufResult<(), T> {
loop_read_exact!(buf, buf.buf_capacity(), read, loop self.read(buf.slice(read..)));
}
/// Read all bytes until underlying reader reaches `EOF`.
async fn read_to_end<#[cfg(feature = "allocator_api")] A: Allocator + 'static>(
&mut self,
mut buf: t_alloc!(Vec, u8, A),
) -> BufResult<usize, t_alloc!(Vec, u8, A)> {
loop_read_to_end!(buf, total: usize, loop self.read(buf.slice(total..)))
}
/// Read the exact number of bytes required to fill the vectored buf.
async fn read_vectored_exact<T: IoVectoredBufMut>(&mut self, buf: T) -> BufResult<(), T> {
loop_read_vectored!(buf, _total: usize, iter, loop self.read_exact(iter))
}
/// Creates an adaptor which reads at most `limit` bytes from it.
///
/// This function returns a new instance of `AsyncRead` which will read
/// at most `limit` bytes, after which it will always return EOF
/// (`Ok(0)`). Any read errors will not count towards the number of
/// bytes read and future calls to [`read()`] may succeed.
///
/// [`read()`]: AsyncRead::read
fn take(self, limit: u64) -> Take<Self>
where
Self: Sized,
{
Take::new(self, limit)
}
read_scalar!(u8, from_be_bytes, from_le_bytes);
read_scalar!(u16, from_be_bytes, from_le_bytes);
read_scalar!(u32, from_be_bytes, from_le_bytes);
read_scalar!(u64, from_be_bytes, from_le_bytes);
read_scalar!(u128, from_be_bytes, from_le_bytes);
read_scalar!(i8, from_be_bytes, from_le_bytes);
read_scalar!(i16, from_be_bytes, from_le_bytes);
read_scalar!(i32, from_be_bytes, from_le_bytes);
read_scalar!(i64, from_be_bytes, from_le_bytes);
read_scalar!(i128, from_be_bytes, from_le_bytes);
read_scalar!(f32, from_be_bytes, from_le_bytes);
read_scalar!(f64, from_be_bytes, from_le_bytes);
}
impl<A: AsyncRead + ?Sized> AsyncReadExt for A {}
/// Implemented as an extension trait, adding utility methods to all
/// [`AsyncReadAt`] types. Callers will tend to import this trait instead of
/// [`AsyncReadAt`].
pub trait AsyncReadAtExt: AsyncReadAt {
/// Read the exact number of bytes required to fill `buffer`.
///
/// This function reads as many bytes as necessary to completely fill the
/// uninitialized space of specified `buffer`.
///
/// # Errors
///
/// If this function encounters an "end of file" before completely filling
/// the buffer, it returns an error of the kind
/// [`ErrorKind::UnexpectedEof`]. The contents of `buffer` are unspecified
/// in this case.
///
/// If any other read error is encountered then this function immediately
/// returns. The contents of `buffer` are unspecified in this case.
///
/// If this function returns an error, it is unspecified how many bytes it
/// has read, but it will never read more than would be necessary to
/// completely fill the buffer.
///
/// [`ErrorKind::UnexpectedEof`]: std::io::ErrorKind::UnexpectedEof
async fn read_exact_at<T: IoBufMut>(&self, mut buf: T, pos: u64) -> BufResult<(), T> {
loop_read_exact!(
buf,
buf.buf_capacity(),
read,
loop self.read_at(buf.slice(read..), pos + read as u64)
);
}
/// Read all bytes until EOF in this source, placing them into `buffer`.
///
/// All bytes read from this source will be appended to the specified buffer
/// `buffer`. This function will continuously call [`read_at()`] to append
/// more data to `buffer` until [`read_at()`] returns [`Ok(0)`].
///
/// If successful, this function will return the total number of bytes read.
///
/// [`read_at()`]: AsyncReadAt::read_at
async fn read_to_end_at<#[cfg(feature = "allocator_api")] A: Allocator + 'static>(
&self,
mut buffer: t_alloc!(Vec, u8, A),
pos: u64,
) -> BufResult<usize, t_alloc!(Vec, u8, A)> {
loop_read_to_end!(buffer, total: u64, loop self.read_at(buffer.slice(total as usize..), pos + total))
}
/// Like [`AsyncReadExt::read_vectored_exact`], expect that it reads at a
/// specified position.
async fn read_vectored_exact_at<T: IoVectoredBufMut>(
&self,
buf: T,
pos: u64,
) -> BufResult<(), T> {
loop_read_vectored!(buf, total: u64, iter, loop self.read_exact_at(iter, pos + total))
}
}
impl<A: AsyncReadAt + ?Sized> AsyncReadAtExt for A {}