Struct b2_client::file::StartLargeFileBuilder

pub struct StartLargeFileBuilder<'a> { /* private fields */ }

A builder for a StartLargeFile request.

Implementations

impl<'a> StartLargeFileBuilder<'a>

pub fn bucket_id(self, id: &'a str) -> Self

Specify the bucket in which to store the new file.

pub fn file_name(
    self,
    name: impl AsRef<str>
) -> Result<Self, FileNameValidationError>

Set the file’s name.

The provided name will be percent-encoded.

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

Set the file’s MIME type.

If not specified, B2 will attempt to determine the file’s type.

pub fn file_info(self, info: Value) -> Result<Self, ValidationError>

Set file metadata to be returned in headers when downloading the file.

For the following headers, use their corresponding methods instead of setting the values here:

• X-Bz-Info-src_last_modified_millis: last_modified
• X-Bz-Info-large_file_sha1: sha1_checksum
• Content-Disposition: content_disposition
• Content-Language: content_language
• Expires: expiration
• Cache-Control: cache_control
• Content-Encoding: content_encoding

If any of the above are set here and via their methods, the value from the method will override the value specified here.

pub fn file_retention(self, policy: FileRetentionPolicy) -> Self

Set the retention policy for the file.

pub fn with_legal_hold(self) -> Self

Enable a legal hold on the file.

pub fn without_legal_hold(self) -> Self

Disable a legal hold on the file.

pub fn encryption_settings(self, settings: ServerSideEncryption) -> Self

Set the server-side encryption configuration for the file.

pub fn last_modified(self, time: DateTime<Utc>) -> Self

The time of the file’s last modification.

pub fn sha1_checksum(self, checksum: &'a str) -> Self

The SHA1 checksum of the file’s contents.

B2 will use this to verify the accuracy of the file upload, and it will be returned in the header X-Bz-Content-Sha1 when downloading the file.

pub fn content_disposition(
    self,
    disposition: ContentDisposition
) -> Result<Self, ValidationError>

The value to use for the Content-Disposition header when downloading the file.

Parameter continuations are not supported.

Note that the download request can override this value.

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

The value to use for the Content-Language header when downloading the file.

Note that the download request can override this value.

pub fn expiration(self, expiration: Expires) -> Self

The value to use for the Expires header when the file is downloaded.

Note that the download request can override this value.

pub fn cache_control(self, cache_control: CacheControl) -> Self

The value to use for the Cache-Control header when the file is downloaded.

This would override the value set at the bucket level, and can be overriden by a download request.

pub fn content_encoding(self, encoding: ContentEncoding) -> Self

The value to use for the Content-Encoding header when the file is downloaded.

Note that this can be overriden by a download request.

pub fn build(self) -> Result<StartLargeFile<'a>, ValidationError>

Trait Implementations

impl<'a> Debug for StartLargeFileBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for StartLargeFileBuilder<'a>

fn default() -> StartLargeFileBuilder<'a>

Returns the “default value” for a type.