Struct RequestBuilder

pub struct RequestBuilder { /* private fields */ }

RequestBuilder provides a mechanism for setting optional parameters on a request.

Each RequestBuilder parameter method call returns Self, so setting of multiple parameters can be chained.

To finalize and submit the request, invoke .await, which which will convert the RequestBuilder into a future executes the request and returns a Result with the parsed response.

In order to execute the request without polling the service until the operation completes, use .send().await instead.

If you need lower-level access to the raw response details (e.g. to inspect response headers or raw body data) then you can finalize the request using the RequestBuilder::send() method which returns a future that resolves to a lower-level Response value.

Implementations

impl RequestBuilder

pub fn snapshot(self, snapshot: impl Into<String>) -> Self

The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.

pub fn versionid(self, versionid: impl Into<String>) -> Self

The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It’s for service version 2019-10-10 and newer.

pub fn timeout(self, timeout: i64) -> Self

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

pub fn x_ms_lease_id(self, x_ms_lease_id: impl Into<String>) -> Self

If specified, the operation only succeeds if the resource’s lease is active and matches this ID.

pub fn x_ms_delete_snapshots( self, x_ms_delete_snapshots: impl Into<String>, ) -> Self

Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob’s snapshots and not the blob itself

pub fn if_modified_since( self, if_modified_since: impl Into<OffsetDateTime>, ) -> Self

Specify this header value to operate only on a blob if it has been modified since the specified date/time.

pub fn if_unmodified_since( self, if_unmodified_since: impl Into<OffsetDateTime>, ) -> Self

Specify this header value to operate only on a blob if it has not been modified since the specified date/time.

pub fn if_match(self, if_match: impl Into<String>) -> Self

Specify an ETag value to operate only on blobs with a matching value.

pub fn if_none_match(self, if_none_match: impl Into<String>) -> Self

Specify an ETag value to operate only on blobs without a matching value.

pub fn x_ms_if_tags(self, x_ms_if_tags: impl Into<String>) -> Self

Specify a SQL where clause on blob tags to operate only on blobs with a matching value.

pub fn x_ms_client_request_id( self, x_ms_client_request_id: impl Into<String>, ) -> Self

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

pub fn deletetype(self, deletetype: impl Into<String>) -> Self

Optional. Only possible value is ‘permanent’, which specifies to permanently delete a blob if blob soft delete is enabled.

pub fn send(self) -> BoxFuture<'static, Result<Response>>

Returns a future that sends the request and returns a Response object that provides low-level access to full response details.

You should typically use .await (which implicitly calls IntoFuture::into_future()) to finalize and send requests rather than send(). However, this function can provide more flexibility when required.

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.