Struct opendal::ObjectReader

impl ObjectReader

pub fn new(meta: ObjectMetadata, inner: BytesReader) -> Self

Create a new object reader.

pub fn with_reader(self, inner: BytesReader) -> Self

Replace the bytes reader with new one.

pub fn map_reader(self, f: impl FnOnce(BytesReader) -> BytesReader) -> Self

Replace the bytes reader with new one.

pub fn into_reader(self) -> BytesReader

Convert into a bytes reader to consume the reader.

pub fn into_parts(self) -> (ObjectMetadata, BytesReader)

Convert into parts.

Notes

This function must be used carefully.

The ObjectMetadata is different from the whole object’s metadata. It just described the corresbonding reader’s metadata.

pub fn content_length(&self) -> u64

Content length of this object reader.

Content-Length is defined by RFC 7230 Refer to MDN Content-Length for more information.

Notes

The content length returned here is the length of this read request. It’s different from the object’s content length.

pub fn last_modified(&self) -> Option<OffsetDateTime>

Last modified of this object.

Last-Modified is defined by RFC 7232 Refer to MDN Last-Modified for more information.

OpenDAL parse the raw value into OffsetDateTime for convenient.

pub fn etag(&self) -> Option<&str>

ETag of this object.

ETag is defined by RFC 7232 Refer to MDN ETag for more information.

OpenDAL will return this value AS-IS like the following:

"33a64df551425fcc55e4d42a148795d9f25f89d4"
W/"0815"

" is part of etag.

Notes

The etag returned here is the etag of this read request. It’s different from the object’s etag.

Trait Implementations§

impl AsyncRead for ObjectReader

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

Attempt to read from the AsyncRead into buf. Read more

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. Read more

Auto Trait Implementations§

impl !UnwindSafe for ObjectReader

Blanket Implementations§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where
Self: Sized,
R: AsyncRead,

Creates an adaptor which will chain this stream with another. Read more

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_vectored<'a>(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
 Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

fn read_to_end<'a>(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self>where
 Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn read_to_string<'a>(
 &'a mut self,
 buf: &'a mut String
) -> ReadToString<'a, Self>where
 Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)where
Self: AsyncWrite + Sized,

Helper method for splitting this read/write object into two halves. Read more

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>where
Self: Unpin,

Reads some bytes from the byte stream. Read more

fn read_vectored<'a>(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>where
 Self: Unpin,

Like [read()][AsyncReadExt::read()], except it reads into a slice of buffers. Read more

fn read_to_end<'a>(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self>where
 Self: Unpin,

Reads the entire contents and appends them to a Vec. Read more

fn read_to_string<'a>(
 &'a mut self,
 buf: &'a mut String
) -> ReadToStringFuture<'a, Self>where
 Self: Unpin,

Reads the entire contents and appends them to a String. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

fn bytes(self) -> Bytes<Self>where
Self: Sized,

Converts this [AsyncRead] into a [Stream] of bytes. Read more

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,
Self: Sized,

Creates an adapter which will chain this stream with another. Read more

fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + Send + 'a, Global>>where
Self: 'a + Sized + Send,

Boxes the reader and changes its type to dyn AsyncRead + Send + 'a. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ReadExt for Twhere
T: AsyncRead + ?Sized,

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>where
Self: Unpin,

Reads some bytes from the byte stream. Read more

fn read_vectored<'a>(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>where
 Self: Unpin,

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

fn read_to_end<'a>(
 &'a mut self,
 buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self>where
 Self: Unpin,

Reads all bytes from the byte stream. Read more

fn read_to_string<'a>(
 &'a mut self,
 buf: &'a mut String
) -> ReadToStringFuture<'a, Self>where
 Self: Unpin,

Reads all bytes from the byte stream and appends them into a string. Read more

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

Creates an adaptor which will read at most limit bytes from it. Read more

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more

fn bytes(self) -> Bytes<Self>where
Self: Sized,

Transforms this Read instance to a Stream over its bytes. Read more

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,
Self: Sized,

Creates an adaptor which will chain this stream with another. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more