Struct MicrosoftAzure 

pub struct MicrosoftAzure { /* private fields */ }

Available on crate feature azure-base only.

Interface for Microsoft Azure Blob Storage.

Implementations

impl MicrosoftAzure

pub fn credentials(&self) -> &AzureCredentialProvider

Returns the AzureCredentialProvider used by MicrosoftAzure

Trait Implementations

impl Clone for MicrosoftAzure

fn clone(&self) -> MicrosoftAzure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MicrosoftAzure

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

Formats the value using the given formatter.

impl Display for MicrosoftAzure

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

Formats the value using the given formatter.

impl MultipartStore for MicrosoftAzure

fn create_multipart<'life0, 'life1, 'async_trait>( &'life0 self, _: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<MultipartId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a new multipart upload, returning its MultipartId.

This is the low-level MultipartStore API, which gives direct control over individual parts. See ObjectStoreExt::put_multipart for a higher-level API that handles parts automatically.

Example

Create a multipart upload, upload two parts, and finalize it by calling complete_multipart:

let azure = MicrosoftAzureBuilder::new()
    .with_account("my-account")
    .with_container_name("my-container")
    .with_access_key("my-access-key")
    .build()?;

let path = Path::from("data/large_file");

// Start the upload, obtaining an id used to reference it in later calls
let id = azure.create_multipart(&path).await?;

// Upload the individual parts. Azure stores each part as a block.
let part0 = azure
    .put_part(&path, &id, 0, PutPayload::from("the first part"))
    .await?;
let part1 = azure
    .put_part(&path, &id, 1, PutPayload::from("the final part"))
    .await?;

// Finalize the upload. The parts must be provided in `part_idx` order.
azure.complete_multipart(&path, &id, vec![part0, part1]).await?;

Azure stores each part as a block, so a single blob may contain at most 50,000 parts, each up to 4,000 MiB. Parts may be uploaded concurrently and in any order, provided each is given the correct part_idx. See Azure block blob limits for the full set of size and count constraints.

Azure has no way to explicitly discard uploaded blocks, so abort_multipart is a no-op: any uncommitted blocks are automatically garbage collected roughly one week after the last write.

fn create_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, opts: PutMultipartOptions, ) -> Pin<Box<dyn Future<Output = Result<MultipartId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a new multipart upload with the given options, returning the MultipartId

fn put_part<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, _: &'life2 MultipartId, __arg3: usize, data: PutPayload, ) -> Pin<Box<dyn Future<Output = Result<PartId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Uploads a new part with index part_idx

fn complete_multipart<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, _: &'life2 MultipartId, parts: Vec<PartId>, ) -> Pin<Box<dyn Future<Output = Result<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Completes a multipart upload

fn abort_multipart<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _: &'life1 Path, _: &'life2 MultipartId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Aborts a multipart upload

impl ObjectStore for MicrosoftAzure

fn put_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, payload: PutPayload, opts: PutOptions, ) -> Pin<Box<dyn Future<Output = Result<PutResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save the provided payload to location with the given options

fn put_multipart_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, opts: PutMultipartOptions, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn MultipartUpload>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a multipart upload with options

fn get_opts<'life0, 'life1, 'async_trait>( &'life0 self, location: &'life1 Path, options: GetOptions, ) -> Pin<Box<dyn Future<Output = Result<GetResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a get request with options

fn list(&self, prefix: Option<&Path>) -> BoxStream<'static, Result<ObjectMeta>>

List all the objects with the given prefix.

fn list_with_offset( &self, prefix: Option<&Path>, offset: &Path, ) -> BoxStream<'static, Result<ObjectMeta>>

List all the objects with the given prefix and a location greater than offset

fn delete_stream( &self, locations: BoxStream<'static, Result<Path>>, ) -> BoxStream<'static, Result<Path>>

Delete all the objects at the specified locations

fn list_with_delimiter<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 Path>, ) -> Pin<Box<dyn Future<Output = Result<ListResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List objects with the given prefix and an implementation specific delimiter. Returns common prefixes (directories) in addition to object metadata.

fn copy_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, options: CopyOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Copy an object from one path to another in the same object store.

fn get_ranges<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, location: &'life1 Path, ranges: &'life2 [Range<u64>], ) -> Pin<Box<dyn Future<Output = Result<Vec<Bytes>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Return the bytes that are stored at the specified location in the given byte ranges

fn rename_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, options: RenameOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move an object from one path to another in the same object store.

impl PaginatedListStore for MicrosoftAzure

fn list_paginated<'life0, 'life1, 'async_trait>( &'life0 self, prefix: Option<&'life1 str>, opts: PaginatedListOptions, ) -> Pin<Box<dyn Future<Output = Result<PaginatedListResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a paginated list request

impl Signer for MicrosoftAzure

fn signed_url<'life0, 'life1, 'async_trait>( &'life0 self, method: Method, path: &'life1 Path, expires_in: Duration, ) -> Pin<Box<dyn Future<Output = Result<Url>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature cloud-base only.

Create a URL containing the relevant Service SAS query parameters that authorize a request via method to the resource at path valid for the duration specified in expires_in.

Unlike S3 and GCS, Azure does not implement Signer::signed_url_opts: a SAS signs a fixed set of fields rather than folding arbitrary query parameters or request headers into the signature, so that method returns an error if extra query parameters or headers are supplied. This is not needed for presigned block-blob uploads — a SAS authorizes by permission and resource, so a client can append the unsigned comp=block and blockid operation parameters to the URL returned by Signer::signed_url.

Example

This example returns a URL that will enable a user to upload a file to “some-folder/some-file.txt” in the next hour.

let azure = MicrosoftAzureBuilder::new()
    .with_account("my-account")
    .with_access_key("my-access-key")
    .with_container_name("my-container")
    .build()?;

let url = azure.signed_url(
    Method::PUT,
    &Path::from("some-folder/some-file.txt"),
    Duration::from_secs(60 * 60)
).await?;

fn signed_urls<'life0, 'life1, 'async_trait>( &'life0 self, method: Method, paths: &'life1 [Path], expires_in: Duration, ) -> Pin<Box<dyn Future<Output = Result<Vec<Url>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature cloud-base only.

Generate signed urls for multiple paths.

fn signed_url_opts<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, method: Method, path: &'life1 Path, expires_in: Duration, options: &'life2 SignedUrlOptions, ) -> Pin<Box<dyn Future<Output = Result<Url>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Available on crate feature cloud-base only.

Like Signer::signed_url, but additionally folds the query parameters and headers in options into the signature. See SignedUrlOptions.