Struct asuran::repository::backend::common::sync_backend::BackendHandle

pub struct BackendHandle<B: SyncBackend> { /* fields omitted */ }

Wrapper Type for sync backends that converts them into async backends

Functions by moving the provided back end into a dedicated tokio task, and then sending SyncCommands to instruct that task on what to do.

Implementations

impl<B> BackendHandle<B> where
    B: SyncBackend + 'static, 

pub fn new(
    queue_depth: usize,
    backend: impl FnOnce() -> B + Send + 'static
) -> Self

Constructs a new BackendHandle

Spawns a new runner thread to handle commands on.

Takes a closure that produces the required SyncBackend, in order to allow injecting non-Send backends into the spawned threads.

queue_depth should be a positive (greater than 0) integer, that represents the number of requests to hold in the processing queue at any given time.

Trait Implementations

impl<B: SyncBackend> Backend for BackendHandle<B>

type Manifest = Self

type Index = Self

fn get_index(&self) -> Self::Index

Returns a view of the index of the repository

fn write_key<'life0, 'life1, 'async_trait>(
    &'life0 self,
    key: &'life1 EncryptedKey
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Writes the specified encrypted key to the backend

fn read_key<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<EncryptedKey>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Attempts to read the encrypted key from the backend.

fn get_manifest(&self) -> Self::Manifest

Returns a view of this respository’s manifest

fn read_chunk<'life0, 'async_trait>(
    &'life0 mut self,
    location: SegmentDescriptor
) -> Pin<Box<dyn Future<Output = Result<Chunk>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Starts reading a chunk from the backend

fn write_chunk<'life0, 'async_trait>(
    &'life0 mut self,
    chunk: Chunk
) -> Pin<Box<dyn Future<Output = Result<SegmentDescriptor>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Starts writing a chunk to the backend

fn close<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Consumes the current backend handle, and does any work necessary to close out the backend properly

fn get_object_handle(&self) -> BackendObject

Creates a new trait-object based BackendHandle

impl<B: SyncBackend> Clone for BackendHandle<B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: SyncBackend> Debug for BackendHandle<B>

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

Formats the value using the given formatter.

impl<B: SyncBackend> Index for BackendHandle<B>

fn lookup_chunk<'life0, 'async_trait>(
    &'life0 mut self,
    id: ChunkID
) -> Pin<Box<dyn Future<Output = Option<SegmentDescriptor>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides the location of a chunk in the repository

fn set_chunk<'life0, 'async_trait>(
    &'life0 mut self,
    id: ChunkID,
    location: SegmentDescriptor
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets the location of a chunk in the repository

fn known_chunks<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = HashSet<ChunkID>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the set of all ChunkIDs known to exist in the Asuran repository.

fn commit_index<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Commits the index

fn count_chunk<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = usize> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the total number of chunks in the index

impl<B: SyncBackend> Manifest for BackendHandle<B>

type Iterator = <<B as SyncBackend>::SyncManifest as SyncManifest>::Iterator

fn last_modification<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<DateTime<FixedOffset>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Timestamp of the last modification

fn chunk_settings<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = ChunkSettings> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the default settings for new chunks in this repository

fn archive_iterator<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Self::Iterator> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns an iterator over the list of archives in this repository, in reverse chronological order (newest first).

fn write_chunk_settings<'life0, 'async_trait>(
    &'life0 mut self,
    settings: ChunkSettings
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Sets the chunk settings in the repository

fn write_archive<'life0, 'async_trait>(
    &'life0 mut self,
    archive: StoredArchive
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Adds an archive to the manifest

fn touch<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Updates the timestamp without performing any other operations

fn seen_versions<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = HashSet<(Version, Uuid)>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provides a list of versions of asuran that have committed to this manifest, in (SemVer, ImplementationUUID)