Struct PruneOptions 

pub struct PruneOptions {
    pub grace: Duration,
    pub dry_run: bool,
}

How S3Cleaner::prune_with decides what nothing reads any more.

Cleaner::prune takes everything the newest version does not point into, less what a compaction attached to it points into (and refuses, deleting nothing, where the inode says one is attached and its metadata does not read). A reader that opened an older version, or a plan made under one and fetched outside the handle, reads objects the newest version no longer points at, and a compaction beside the writer writes copies nothing points at until it attaches them. grace keeps both:

• every object that a version current at any time in the last grace points into: each checkpoint published in it, and the version current when it began;
• every object written in the last grace.

So grace has to be longer than any reader holds a version, and a compaction’s max_age shorter than grace. Times are the store’s. Nothing above the newest published number is taken either way: the writer’s next checkpoint is being written there.

Fields

grace: Duration

How long a version is kept after it stops being the newest, and an object after it is written. Zero is Cleaner::prune.

dry_run: bool

Decide and report, delete nothing.

Trait Implementations

impl Clone for PruneOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PruneOptions

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

Formats the value using the given formatter.

impl Default for PruneOptions

fn default() -> Self

Returns the “default value” for a type.