Struct opendal::operator_futures::OperatorFuture

pub struct OperatorFuture<I, O, F: Future<Output = Result<O>>> { /* private fields */ }

OperatorFuture is the future generated by Operator.

The future will consume all the input to generate a future.

NOTES

This struct is by design to keep in crate. We don’t want users to use this struct directly.

Implementations

impl<F: Future<Output = Result<Metadata>>> OperatorFuture<OpStat, Metadata, F>

pub fn if_match(self, v: &str) -> Self

Set the If-Match for this operation.

pub fn if_none_match(self, v: &str) -> Self

Set the If-None-Match for this operation.

pub fn version(self, v: &str) -> Self

Set the version for this operation.

impl<F: Future<Output = Result<PresignedRequest>>> OperatorFuture<(OpStat, Duration), PresignedRequest, F>

pub fn override_content_disposition(self, v: &str) -> Self

Sets the content-disposition header that should be sent back by the remote read operation.

pub fn override_cache_control(self, v: &str) -> Self

Sets the cache-control header that should be sent back by the remote read operation.

pub fn override_content_type(self, v: &str) -> Self

Sets the content-type header that should be sent back by the remote read operation.

pub fn if_match(self, v: &str) -> Self

Set the If-Match of the option

pub fn if_none_match(self, v: &str) -> Self

Set the If-None-Match of the option

impl<F: Future<Output = Result<PresignedRequest>>> OperatorFuture<(OpRead, Duration), PresignedRequest, F>

pub fn override_content_disposition(self, v: &str) -> Self

Sets the content-disposition header that should be sent back by the remote read operation.

pub fn override_cache_control(self, v: &str) -> Self

Sets the cache-control header that should be sent back by the remote read operation.

pub fn override_content_type(self, v: &str) -> Self

Sets the content-type header that should be sent back by the remote read operation.

pub fn if_match(self, v: &str) -> Self

Set the If-Match of the option

pub fn if_none_match(self, v: &str) -> Self

Set the If-None-Match of the option

impl<F: Future<Output = Result<PresignedRequest>>> OperatorFuture<(OpWrite, Duration), PresignedRequest, F>

pub fn content_type(self, v: &str) -> Self

Set the content type of option

pub fn content_disposition(self, v: &str) -> Self

Set the content disposition of option

pub fn cache_control(self, v: &str) -> Self

Set the content type of option

impl<F: Future<Output = Result<Buffer>>> OperatorFuture<(OpRead, OpReader), Buffer, F>

pub fn if_match(self, v: &str) -> Self

Set the If-Match for this operation.

pub fn if_none_match(self, v: &str) -> Self

Set the If-None-Match for this operation.

pub fn version(self, v: &str) -> Self

Set the version for this operation.

pub fn executor(self, executor: Executor) -> Self

Set the executor for this operation.

pub fn range(self, range: impl RangeBounds<u64>) -> Self

Set the range header for this operation.

pub fn concurrent(self, concurrent: usize) -> Self

Set the concurrent read task amount.

pub fn chunk(self, chunk_size: usize) -> Self

Set the chunk size for this operation.

impl<F: Future<Output = Result<Reader>>> OperatorFuture<(OpRead, OpReader), Reader, F>

pub fn version(self, v: &str) -> Self

Set the version for this operation.

pub fn concurrent(self, concurrent: usize) -> Self

Set the concurrent read task amount.

pub fn chunk(self, chunk_size: usize) -> Self

Set the chunk size for this reader.

pub fn gap(self, gap_size: usize) -> Self

Set the gap size for this reader.

impl<F: Future<Output = Result<()>>> OperatorFuture<(OpWrite, OpWriter, Buffer), (), F>

pub fn append(self, v: bool) -> Self

Set the append mode of op.

If the append mode is set, the data will be appended to the end of the file.

Notes

Service could return Unsupported if the underlying storage does not support append.

pub fn chunk(self, v: usize) -> Self

Set the buffer size of op.

If buffer size is set, the data will be buffered by the underlying writer.

NOTE

Service could have their own minimum buffer size while perform write operations like multipart uploads. So the buffer size may be larger than the given buffer size.

pub fn concurrent(self, v: usize) -> Self

Set the maximum concurrent write task amount.

pub fn cache_control(self, v: &str) -> Self

Set the content type of option

pub fn content_type(self, v: &str) -> Self

Set the content type of option

pub fn content_disposition(self, v: &str) -> Self

Set the content disposition of option

pub fn executor(self, executor: Executor) -> Self

Set the executor for this operation.

pub fn if_none_match(self, s: &str) -> Self

Set the If-None-Match for this operation.

pub fn if_not_exists(self, b: bool) -> Self

Set the If-Not-Exist for this operation.

pub fn user_metadata( self, data: impl IntoIterator<Item = (String, String)>, ) -> Self

Set the user defined metadata of the op

Notes

we don’t need to include the user defined metadata prefix in the key every service will handle it internally

impl<F: Future<Output = Result<Writer>>> OperatorFuture<(OpWrite, OpWriter), Writer, F>

pub fn append(self, v: bool) -> Self

Set the append mode of op.

If the append mode is set, the data will be appended to the end of the file.

Notes

Service could return Unsupported if the underlying storage does not support append.

pub fn chunk(self, v: usize) -> Self

Set the chunk size of op.

If chunk size is set, the data will be chunked by the underlying writer.

NOTE

Service could have their own limitation for chunk size. It’s possible that chunk size is not equal to the given chunk size.

For example:

• AWS S3 requires the part size to be in [5MiB, 5GiB].
• GCS requires the part size to be aligned with 256 KiB.

The services will alter the chunk size to meet their requirements.

pub fn concurrent(self, v: usize) -> Self

Set the maximum concurrent write task amount.

pub fn cache_control(self, v: &str) -> Self

Set the content type of option

pub fn content_type(self, v: &str) -> Self

Set the content type of option

pub fn content_disposition(self, v: &str) -> Self

Set the content disposition of option

pub fn executor(self, executor: Executor) -> Self

Set the executor for this operation.

pub fn user_metadata( self, data: impl IntoIterator<Item = (String, String)>, ) -> Self

Set the user defined metadata of the op

Notes

we don’t need to include the user defined metadata prefix in the key. every service will handle it internally

impl<F: Future<Output = Result<()>>> OperatorFuture<OpDelete, (), F>

pub fn version(self, v: &str) -> Self

Change the version of this delete operation.

impl<F: Future<Output = Result<Vec<Entry>>>> OperatorFuture<OpList, Vec<Entry>, F>

pub fn limit(self, v: usize) -> Self

The limit passed to underlying service to specify the max results that could return per-request.

Users could use this to control the memory usage of list operation.

pub fn start_after(self, v: &str) -> Self

The start_after passes to underlying service to specify the specified key to start listing from.

pub fn recursive(self, v: bool) -> Self

The recursive is used to control whether the list operation is recursive.

• If false, list operation will only list the entries under the given path.
• If true, list operation will list all entries that starts with given path.

Default to false.

pub fn version(self, v: bool) -> Self

The version is used to control whether the object versions should be returned.

• If false, list operation will not return with object versions
• If true, list operation will return with object versions if object versioning is supported by the underlying service

Default to false

impl<F: Future<Output = Result<Lister>>> OperatorFuture<OpList, Lister, F>

pub fn limit(self, v: usize) -> Self

The limit passed to underlying service to specify the max results that could return per-request.

Users could use this to control the memory usage of list operation.

pub fn start_after(self, v: &str) -> Self

The start_after passes to underlying service to specify the specified key to start listing from.

pub fn recursive(self, v: bool) -> Self

The recursive is used to control whether the list operation is recursive.

• If false, list operation will only list the entries under the given path.
• If true, list operation will list all entries that starts with given path.

Default to false.

pub fn version(self, v: bool) -> Self

The version is used to control whether the object versions should be returned.

• If false, list operation will not return with object versions
• If true, list operation will return with object versions if object versioning is supported by the underlying service

Default to false

Trait Implementations

impl<I, O, F> IntoFuture for OperatorFuture<I, O, F>

where F: Future<Output = Result<O>>,

type Output = Result<O, Error>

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.