Trait opendal::raw::oio::BlockingRead

pub trait BlockingRead: Send + Sync + 'static {
    // Required methods
    fn read(&mut self, buf: &mut [u8]) -> Result<usize>;
    fn seek(&mut self, pos: SeekFrom) -> Result<u64>;
    fn next(&mut self) -> Option<Result<Bytes>>;
}

Read is the trait that OpenDAL returns to callers.

Read is compose of the following trait

• Read
• Seek
• Iterator<Item = Result<Bytes>>

Read is required to be implemented, Seek and Iterator is optional. We use Read to make users life easier.

Required Methods

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Read synchronously.

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek synchronously.

fn next(&mut self) -> Option<Result<Bytes>>

Iterating Bytes from underlying reader.

Trait Implementations

impl Iterator for dyn BlockingRead

type Item = Result<Bytes, Error>

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn advance_by(&mut self, n: usize) -> Result<(), usize>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

impl Read for dyn BlockingRead

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

impl Seek for dyn BlockingRead

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

Implementations on Foreign Types

impl BlockingRead for ()

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

fn next(&mut self) -> Option<Result<Bytes>>

impl<T: BlockingRead + ?Sized> BlockingRead for Box<T>

Box<dyn BlockingRead> won’t implement BlockingRead automatically. To make BlockingReader work as expected, we must add this impl.

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

fn next(&mut self) -> Option<Result<Bytes>>

Implementors

impl BlockingRead for BlockingReader

impl BlockingRead for Cursor

impl<R> BlockingRead for FdReader<R>where R: Read + Seek + Send + Sync + 'static,

impl<R: BlockingRead> BlockingRead for IntoStreamableReader<R>