Struct Archive 

pub struct Archive { /* private fields */ }

A read and write handle on the archive, with the operator’s key prefix applied.

Implementations

impl Archive

pub fn open(args: &ArchiveArgs) -> Result<Self, BackupError>

Build the handle the --archive-* flags describe.

Errors

Returns BackupError::InvalidArgument when the flags contradict each other, and BackupError::ObjectStore when the backend builder rejects the bucket, region, endpoint, or credentials.

pub fn key(&self, relative: &str) -> Path

The absolute object key for a path relative to the archive root.

pub async fn put( &self, relative: &str, bytes: Vec<u8>, ) -> Result<(), BackupError>

Write one object, overwriting whatever was there.

Errors

Returns BackupError::ObjectStore when the write fails.

pub async fn put_new( &self, relative: &str, bytes: Vec<u8>, ) -> Result<(), BackupError>

Create a capture object, refusing to replace an existing object.

Errors

Returns BackupError::ObjectStore when the key already exists or the write fails.

pub async fn get(&self, relative: &str) -> Result<Vec<u8>, BackupError>

Read one object whole.

Errors

Returns BackupError::ObjectStore when the object is absent or the read fails.

pub async fn get_capped( &self, relative: &str, max_bytes: u64, ) -> Result<Vec<u8>, BackupError>

Read an archive-relative object within an independent byte limit.

Errors

Returns BackupError::ObjectStore when the object is absent, exceeds max_bytes, changes during the read, or cannot be read.

pub async fn get_absolute_capped( &self, key: &str, max_bytes: u64, ) -> Result<Vec<u8>, BackupError>

Read an exact object key, refusing oversized bodies before buffering.

Errors

Returns BackupError::ObjectStore when the object is absent, exceeds max_bytes, or cannot be read.

pub async fn child_directories( &self, relative: &str, ) -> Result<BTreeSet<String>, BackupError>

The distinct directory names one level below relative.

Object stores have no directories, so this lists the keys under the prefix and keeps the segment that follows it. An empty listing is an empty set rather than an error: a bucket that has never been captured into is not a failure, and the caller says what that means.

Errors

Returns BackupError::ObjectStore when the listing fails.