Struct BlobClient

pub struct BlobClient { /* private fields */ }

A client to interact with a specific Azure storage blob, although that blob may not yet exist.

Implementations

impl BlobClient

pub fn new( endpoint: &str, container_name: String, blob_name: String, credential: Arc<dyn TokenCredential>, options: Option<BlobClientOptions>, ) -> Result<Self>

Creates a new BlobClient, 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 blob.
• blob_name - The name of the 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 endpoint(&self) -> &Url

Gets the endpoint of the Storage account this client is connected to.

pub fn container_name(&self) -> &str

Gets the container name of the Storage account this client is connected to.

pub fn blob_name(&self) -> &str

Gets the blob name of the Storage account this client is connected to.

pub async fn get_properties( &self, options: Option<BlobClientGetPropertiesOptions<'_>>, ) -> Result<Response<BlobClientGetPropertiesResult>>

Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. The data returned does not include the content of the blob.

Arguments

• options - Optional configuration for the request.

pub async fn download( &self, options: Option<BlobClientDownloadOptions<'_>>, ) -> Result<Response<BlobClientDownloadResult>>

Downloads a blob from the service, including its metadata and properties.

Arguments

• options - Optional configuration for the request.

pub async fn upload( &self, data: RequestContent<Bytes>, overwrite: bool, content_length: u64, options: Option<BlockBlobClientUploadOptions<'_>>, ) -> Result<Response<BlockBlobClientUploadResult>>

Creates a new 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 delete( &self, options: Option<BlobClientDeleteOptions<'_>>, ) -> Result<Response<()>>

Deletes the blob.

Arguments

• options - Optional configuration for the request.

pub async fn commit_block_list( &self, blocks: RequestContent<BlockLookupList>, options: Option<BlockBlobClientCommitBlockListOptions<'_>>, ) -> Result<Response<BlockBlobClientCommitBlockListResult>>

Writes to a 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 stage_block( &self, block_id: Vec<u8>, content_length: u64, body: RequestContent<Bytes>, options: Option<BlockBlobClientStageBlockOptions<'_>>, ) -> Result<Response<BlockBlobClientStageBlockResult>>

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 get_block_list( &self, list_type: BlockListType, options: Option<BlockBlobClientGetBlockListOptions<'_>>, ) -> Result<Response<BlockList>>

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.