Struct b2_client::bucket::LifecycleRuleBuilder

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

A builder for a LifecycleRule.

See https://www.backblaze.com/b2/docs/lifecycle_rules.html for information on bucket lifecycles.

Implementations

impl<'a> LifecycleRuleBuilder<'a>

pub fn filename_prefix(
    self,
    prefix: &'a str
) -> Result<Self, FileNameValidationError>

The filename prefix to select the files that are subject to the rule.

A prefix of "" will apply to all files, allowing the creation of rules that could delete all files.

pub fn hide_after_upload(self, days: Duration) -> Result<Self, ValidationError>

The number of days to hide a file after it was uploaded.

The supplied duration will be truncated to whole days. If provided, the number of days must be at least one.

The maximum number of days supported is u16::MAX.

pub fn delete_after_hide(self, days: Duration) -> Result<Self, ValidationError>

The number of days to delete a file after it was hidden.

The supplied duration will be truncated to whole days. If provided, the number of days must be at least one.

The maximum number of days supported is u16::MAX.

Notes

The B2 service automatically hides files when a file with the same is uploaded (e.g., when a file changes). Files can also be explicitly hidden via hide_file.

pub fn build(self) -> Result<LifecycleRule, ValidationError>

Create a LifecycleRule.

Errors

Returns ValidationError::MissingData if no filename prefix is provided, or ValidationError::Incompatible if the rule does not have at least one of a hide_after_upload or delete_after_hide rule set.

Trait Implementations

impl<'a> Default for LifecycleRuleBuilder<'a>

fn default() -> LifecycleRuleBuilder<'a>

Returns the “default value” for a type.