Struct Archive

pub struct Archive<T: Translator, B: Blob, E: Storage<B>> { /* private fields */ }

Implementation of Archive storage.

Implementations

impl<T: Translator, B: Blob, E: Storage<B>> Archive<T, B, E>

pub async fn init(journal: Journal<B, E>, cfg: Config<T>) -> Result<Self, Error>

Initialize a new Archive instance.

The in-memory index for Archive is populated during this call by replaying the journal.

pub async fn put( &mut self, index: u64, key: &[u8], data: Bytes, ) -> Result<(), Error>

Store an item in Archive. Both indices and keys are assumed to both be globally unique.

If the index already exists, an error is returned. If the same key is stored multiple times at different indices (not recommended), any value associated with the key may be returned.

pub async fn get( &self, identifier: Identifier<'_>, ) -> Result<Option<Bytes>, Error>

Retrieve an item from Archive.

pub async fn has(&self, identifier: Identifier<'_>) -> Result<bool, Error>

Check if an item exists in the Archive.

pub async fn prune(&mut self, min: u64) -> Result<(), Error>

Prune Archive to the provided min (masked by the configured section mask).

If this is called with a min lower than the last pruned, nothing will happen.

pub async fn sync(&mut self) -> Result<(), Error>

Forcibly sync all pending writes across all Journals.

pub fn next_gap(&self, index: u64) -> (Option<u64>, Option<u64>)

Retrieve the end of the current range including index (inclusive) and the start of the next range after index (if it exists).

This is useful for driving backfill operations over the archive.

pub async fn close(self) -> Result<(), Error>

Close Archive (and underlying Journal).

Any pending writes will be synced by Journal prior to closing.