Struct asuran::repository::backend::multifile::MultiFile

pub struct MultiFile { /* fields omitted */ }

Methods

impl MultiFile

pub async fn open_defaults<'_>(
    path: impl AsRef<Path>,
    chunk_settings: Option<ChunkSettings>,
    key: &'_ Key
) -> Result<MultiFile>

Opens a new MultiFile backend with default settings

Subject to change in the near future

Errors

Will error if creating or locking any of the index or manifest files fails (such as if the user does not have permissions for that directory), or if any other I/O error occurs

pub fn read_key(path: impl AsRef<Path>) -> Result<EncryptedKey>

Reads the encrypted key off the disk

Does not require that the repository be opened first

Note: this path is the repository root path, not the key path

Errors

Will error if the key is corrupted or deserialization otherwise fails

Trait Implementations

impl Backend for MultiFile

type Manifest = Manifest

type Index = Index

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

Clones the internal MFManifest

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

Clones the internal MFIndex

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, 

Locks the keyfile and writes the key

Will return Err if writing the key fails

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 key from the repository

Returns Err if the key doesn't exist or of another error occurs

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, and returns a oneshot recieve with the result of that process

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, and returns a oneshot reciever with the result of that process

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

Closes out the index, segment handler, and manifest cleanly, making sure all operations are completed and all drop impls from inside the tasks are called

fn get_object_handle(&self) -> BackendObject

Creates a new trait-object based BackendHandle

impl Clone for MultiFile

fn clone(&self) -> MultiFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiFile

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

Formats the value using the given formatter.