Struct asuran::repository::backend::multifile::index::Index

pub struct Index { /* fields omitted */ }

Methods

impl Index

MultiFile index with lock free multithreading

Warning

You must call commit_index for your changes to be committed to disk, the Index will not do this for you

pub fn open(repository_path: impl AsRef<Path>) -> Result<Index>

Opens and reads the index, creating it if it does not exist.

Note that the repository path is the root path of the repository, not the path of the index folder.

This method will create the index folder if it does not exist.

Files who's names are not strictly base 10 integers are ignored, and will not be added to the state or written to.

This method only creates the event loop on its own, the actual index is created by InternalIndex::open

Errors

Will return Err if

1. The index folder does not exist and creating it failed
2. There are no unlocked index files and creating one fails
3. There is a file called "index" in the repository folder
4. Some other IO error (such as lack of permissions) occurs
5. The path contains non-utf8 characters

TODOs:

1. Return an error if deserializing a transaction fails before the end of the file is reached
2. This function can currently panic if we have to create a new index file, but someone else that while we were parsing the transaction. Resolution for this conflict needs to be implemented.

pub async fn close<'_>(&'_ mut self)

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Index for Index

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