Struct asuran::repository::Repository

pub struct Repository<T> {
    pub queue_depth: usize,
    // some fields omitted
}

Provides an interface to the storage-backed key value store

File access is abstracted behind a swappable backend, all backends should use roughly the same format, but leeway is made for cases such as S3 having a flat directory structure

Fields

queue_depth: usize

Depth of queues to build

Implementations

impl<T: BackendClone + 'static> Repository<T>

pub fn new(
    backend: T,
    compression: Compression,
    hmac: HMAC,
    encryption: Encryption,
    key: Key,
    pipeline_tasks: usize
) -> Repository<T>

Creates a new repository with the specificed backend and defaults

pub fn with(
    backend: T,
    settings: ChunkSettings,
    key: Key,
    pipeline_tasks: usize
) -> Repository<T>

Creates a new repository, accepting a ChunkSettings and a ThreadPool

pub async fn commit_index(&self)

Commits the index to storage

This should be called every time an archive or manifest is written, at the very least

pub async fn write_raw(
    &mut self,
    chunk: Chunk
) -> Result<(ChunkID, bool), RepositoryError>

Writes a chunk directly to the repository

Will return (Chunk_ID, Already_Present)

Already_Present will be true if the chunk already exists in the repository.

pub async fn write_chunk(
    &mut self,
    data: Vec<u8>
) -> Result<(ChunkID, bool), RepositoryError>

Writes a chunk to the repo

Uses all defaults

Will return None if writing the chunk fails. Will not write the chunk if it already exists. Bool in return value will be true if the chunk already existed in the Repository, and false otherwise

pub async fn write_chunk_with_id(
    &mut self,
    data: Vec<u8>,
    id: ChunkID
) -> Result<(ChunkID, bool), RepositoryError>

Writes a chunk to the repo

Uses all defaults

Will return None if writing the chunk fails. Will not write the chunk if it already exists.

Manually sets the id of the written chunk. This should be used carefully, as it has potential to damage the repository.

Primiarly intended for writing the manifest

pub async fn has_chunk(&self, id: ChunkID) -> bool

Determines if a chunk exists in the index

pub async fn read_chunk(
    &mut self,
    id: ChunkID
) -> Result<Vec<u8>, RepositoryError>

Reads a chunk from the repo

Returns none if reading the chunk fails

pub async fn count_chunk(&self) -> usize

Provides a count of the number of chunks in the repository

pub fn chunk_settings(&self) -> ChunkSettings

Returns the current default chunk settings for this repository

pub fn key(&self) -> &Key

Gets a refrence to the repository’s key

pub fn backend_manifest(&self) -> T::Manifest

Provides a handle to the backend manifest

pub async fn close(self)

Performs any work that would normally be done in a drop impl, but needs to be done asyncronsyly.

Calls into the backend’s implementation

pub async fn seen_versions(&self) -> HashSet<(Version, Uuid)>

Returns a set of all version and implementation pairs that have touched this repository in the past.

Trait Implementations

impl<T: Clone> Clone for Repository<T>

fn clone(&self) -> Repository<T>

Returns a copy of the value.

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

Performs copy-assignment from source.