Struct asuran::repository::backend::multifile::manifest::Manifest

pub struct Manifest { /* fields omitted */ }

A message-passing handle to a running manifest

Warnings

1. In order to ensure that file locks are freed and data is writeen properly, you must ensure that you call the close method on the manifest before your program terminates

Implementations

impl Manifest

pub fn open(
    repository_path: impl AsRef<Path>,
    chunk_settings: Option<ChunkSettings>,
    key: &Key,
    queue_depth: usize
) -> Result<Manifest>

Opens and reads the manifest, 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 manifest folder if it does not exist.

Files whose 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, the actual manifest is created by InternalManifest::open

This method can optinally set the chunksettings for the manifest, but it is an error to not provide chunk settings if the manifest has not been created yet

Errors

Will return Err if

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

TODOs:

1. Return an error if deserializing a transaciton fails before the end of the file is reached
2. This function can currently panic if we have to create a new manifest file, but someone else creates the same file we are trying to first.

pub async fn close(&mut self)

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl Manifest for Manifest

type Iterator = IntoIter<StoredArchive>

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)