[Storage] [WIP] Handwritten BlockBlobClient
#2505
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| use crate::{ | ||
| generated::clients::BlockBlobClient as GeneratedBlockBlobClient, | ||
| generated::models::{ | ||
| BlobClientDownloadResult, BlobClientGetPropertiesResult, | ||
| BlockBlobClientCommitBlockListResult, BlockBlobClientStageBlockResult, | ||
| BlockBlobClientUploadResult, | ||
| }, | ||
| models::{BlockList, BlockListType, BlockLookupList, StorageServiceProperties}, | ||
| pipeline::StorageHeadersPolicy, | ||
| BlobClientDeleteOptions, BlobClientDownloadOptions, BlobClientGetPropertiesOptions, | ||
| BlobClientOptions, BlobClientSetMetadataOptions, BlobClientSetPropertiesOptions, | ||
| BlobClientSetTierOptions, BlockBlobClientCommitBlockListOptions, | ||
| BlockBlobClientGetBlockListOptions, BlockBlobClientOptions, BlockBlobClientStageBlockOptions, | ||
| BlockBlobClientUploadOptions, | ||
| }; | ||
| use azure_core::{ | ||
| credentials::TokenCredential, | ||
| http::{ | ||
| policies::{BearerTokenCredentialPolicy, Policy}, | ||
| RequestContent, Response, Url, | ||
| }, | ||
| Bytes, Result, | ||
| }; | ||
| use std::sync::Arc; | ||
|
|
||
| /// A client to interact with a specific Azure storage Block blob, although that blob may not yet exist. | ||
| pub struct BlockBlobClient { | ||
| endpoint: Url, | ||
| client: GeneratedBlockBlobClient, | ||
| } | ||
|
|
||
| impl BlockBlobClient { | ||
| /// Creates a new BlockBlobClient, using Entra ID authentication. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `endpoint` - The full URL of the Azure storage account, for example `https://myaccount.blob.core.windows.net/` | ||
| /// * `container_name` - The name of the container containing this Block blob. | ||
| /// * `blob_name` - The name of the Block blob to interact with. | ||
| /// * `credential` - An implementation of [`TokenCredential`] that can provide an Entra ID token to use when authenticating. | ||
| /// * `options` - Optional configuration for the client. | ||
| pub fn new( | ||
| endpoint: &str, | ||
| container_name: String, | ||
| blob_name: String, | ||
| credential: Arc<dyn TokenCredential>, | ||
| options: Option<BlockBlobClientOptions>, | ||
| ) -> Result<Self> { | ||
| let mut options = options.unwrap_or_default(); | ||
|
|
||
| let storage_headers_policy = Arc::new(StorageHeadersPolicy); | ||
| options | ||
| .client_options | ||
| .per_call_policies | ||
| .push(storage_headers_policy); | ||
|
|
||
| let oauth_token_policy = BearerTokenCredentialPolicy::new( | ||
| credential.clone(), | ||
| ["https://storage.azure.com/.default"], | ||
| ); | ||
| options | ||
| .client_options | ||
| .per_try_policies | ||
| .push(Arc::new(oauth_token_policy) as Arc<dyn Policy>); | ||
|
|
||
| let client = GeneratedBlockBlobClient::new( | ||
| endpoint, | ||
| credential.clone(), | ||
| container_name.clone(), | ||
| blob_name.clone(), | ||
| Some(options), | ||
| )?; | ||
| Ok(Self { | ||
| endpoint: endpoint.parse()?, | ||
| client, | ||
| }) | ||
| } | ||
|
|
||
| /// Gets the endpoint of the Storage account this client is connected to. | ||
| pub fn endpoint(&self) -> &Url { | ||
| &self.endpoint | ||
| } | ||
|
|
||
| /// Gets the container name of the Storage account this client is connected to. | ||
| pub fn container_name(&self) -> &str { | ||
| &self.client.container_name | ||
| } | ||
|
|
||
| /// Gets the blob name of the Storage account this client is connected to. | ||
| pub fn blob_name(&self) -> &str { | ||
| &self.client.blob_name | ||
| } | ||
|
|
||
| /// Creates a new Block blob from a data source. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `data` - The blob data to upload. | ||
| /// * `overwrite` - Whether the blob to be uploaded should overwrite the current data. If True, `upload_blob` will overwrite the existing data. | ||
| /// If False, the operation will fail with ResourceExistsError. | ||
| /// * `content_length` - Total length of the blob data to be uploaded. | ||
| /// * `options` - Optional configuration for the request. | ||
| pub async fn upload( | ||
|
There was a problem hiding this comment. Leave this in base blob client. |
||
| &self, | ||
| data: RequestContent<Bytes>, | ||
| overwrite: bool, | ||
| content_length: u64, | ||
| options: Option<BlockBlobClientUploadOptions<'_>>, | ||
| ) -> Result<Response<BlockBlobClientUploadResult>> { | ||
| let mut options: BlockBlobClientUploadOptions<'_> = options.unwrap_or_default(); | ||
|
|
||
| if !overwrite { | ||
| options.if_none_match = Some(String::from("*")); | ||
| } | ||
|
|
||
| let response = self | ||
| .client | ||
| .upload(data, content_length, Some(options)) | ||
| .await?; | ||
| Ok(response) | ||
| } | ||
|
|
||
| /// Writes to a Block blob based on blocks specified by the list of IDs and content that make up the blob. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `blocks` - The list of Blob blocks to commit. | ||
| /// * `options` - Optional configuration for the request. | ||
| pub async fn commit_block_list( | ||
| &self, | ||
| blocks: RequestContent<BlockLookupList>, | ||
| options: Option<BlockBlobClientCommitBlockListOptions<'_>>, | ||
| ) -> Result<Response<BlockBlobClientCommitBlockListResult>> { | ||
| let response = self.client.commit_block_list(blocks, options).await?; | ||
| Ok(response) | ||
| } | ||
|
|
||
| /// Creates a new block to be later committed as part of a blob. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `block_id` - The unique identifier for the block. The identifier should be less than or equal to 64 bytes in size. | ||
| /// For a given blob, the `block_id` must be the same size for each block. | ||
| /// * `content_length` - Total length of the blob data to be staged. | ||
| /// * `data` - The content of the block. | ||
| /// * `options` - Optional configuration for the request. | ||
| pub async fn stage_block( | ||
| &self, | ||
| block_id: Vec<u8>, | ||
| content_length: u64, | ||
| body: RequestContent<Bytes>, | ||
| options: Option<BlockBlobClientStageBlockOptions<'_>>, | ||
| ) -> Result<Response<BlockBlobClientStageBlockResult>> { | ||
| let response = self | ||
| .client | ||
| .stage_block(block_id, content_length, body, options) | ||
| .await?; | ||
| Ok(response) | ||
| } | ||
|
|
||
| /// Retrieves the list of blocks that have been uploaded as part of a block blob. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `list_type` - Specifies whether to return the list of committed blocks, uncommitted blocks, or both lists together. | ||
| /// * `options` - Optional configuration for the request. | ||
| pub async fn get_block_list( | ||
| &self, | ||
| list_type: BlockListType, | ||
| options: Option<BlockBlobClientGetBlockListOptions<'_>>, | ||
| ) -> Result<Response<BlockList>> { | ||
| let response = self.client.get_block_list(list_type, options).await?; | ||
| Ok(response) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a precedent on whether sub-clients should inherit options, or should they be explicitly set and default otherwise.
I think for Service vs. Container vs. Blob it makes sense to not be passing the options bag, but I could see the argument since these subclients are all Blob-based -- but wanted to see if we have any precedent in other languages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, will change this to
block_blob_clientas per subclient naming guidelines.