Struct FuturesAsyncReader 

pub struct FuturesAsyncReader {
    ctx: Arc<ReadContext>,
    stream: BufferStream,
    buf: Buffer,
    start: u64,
    range_end: Option<u64>,
    content_length: Option<u64>,
    end_fut: Option<Pin<Box<dyn Future<Output = Result<u64, Error>> + Send>>>,
    stream_is_unbounded: bool,
    pos: u64,
    eof: bool,
}

FuturesAsyncReader is the adapter of [AsyncRead], [AsyncBufRead] and [AsyncSeek] generated by Reader::into_futures_async_read.

Users can use this adapter in cases where they need to use [AsyncRead] related trait. FuturesAsyncReader reuses the same concurrent and chunk settings from Reader.

An unbounded read treats ErrorKind::RangeNotSatisfied as EOF. Bounded reads and other errors are propagated.

FuturesAsyncReader also implements Unpin, Send and Sync

Fields

ctx: Arc<ReadContext>

stream: BufferStream

buf: Buffer

start: u64

range_end: Option<u64>

content_length: Option<u64>

end_fut: Option<Pin<Box<dyn Future<Output = Result<u64, Error>> + Send>>>

stream_is_unbounded: bool

pos: u64

eof: bool

Implementations

impl FuturesAsyncReader

pub async fn read_buffer(&mut self, size: usize) -> Result<Buffer, Error>

Read at most size bytes and return them as an OpenDAL Buffer.

This method preserves the underlying buffer storage and does not copy the payload. It can return fewer bytes than requested, including an empty buffer at EOF.

pub async fn read_to_end_buffer(&mut self) -> Result<Buffer, Error>

Read all remaining bytes and return them as an OpenDAL Buffer.

This method preserves the underlying buffer storage and only allocates metadata when multiple buffers must be combined.

Trait Implementations

impl AsyncBufRead for FuturesAsyncReader

fn poll_fill_buf( self: Pin<&mut FuturesAsyncReader>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8], Error>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut FuturesAsyncReader>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl AsyncRead for FuturesAsyncReader

TODO: implement vectored read.

fn poll_read( self: Pin<&mut FuturesAsyncReader>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncSeek for FuturesAsyncReader

fn poll_seek( self: Pin<&mut FuturesAsyncReader>, cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64, Error>>

Attempt to seek to an offset, in bytes, in a stream.

impl Sync for FuturesAsyncReader

Safety: FuturesAsyncReader only exposes &mut self to the outside world,