Struct object_store::GetResult

pub struct GetResult {
    pub payload: GetResultPayload,
    pub meta: ObjectMeta,
    pub range: Range<usize>,
    pub attributes: Attributes,
}

Result for a get request

Fields

payload: GetResultPayload

The GetResultPayload

meta: ObjectMeta

The ObjectMeta for this object

range: Range<usize>

The range of bytes returned by this request

attributes: Attributes

Additional object attributes

Implementations

impl GetResult

pub async fn bytes(self) -> Result<Bytes>

Collects the data into a Bytes

pub fn into_stream(self) -> BoxStream<'static, Result<Bytes>>

Converts this into a byte stream

If the self.kind is GetResultPayload::File will perform chunked reads of the file, otherwise will return the GetResultPayload::Stream.

Tokio Compatibility

Tokio discourages performing blocking IO on a tokio worker thread, however, no major operating systems have stable async file APIs. Therefore if called from a tokio context, this will use tokio::runtime::Handle::spawn_blocking to dispatch IO to a blocking thread pool, much like tokio::fs does under-the-hood.

If not called from a tokio context, this will perform IO on the current thread with no additional complexity or overheads

Trait Implementations

impl Debug for GetResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.