vfstool_lib 0.9.0

A library for constructing and manipulating virtual file systems in Rust, based on OpenMW's VFS implementation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// SPDX-License-Identifier: GPL-3.0-only
use std::{
    fmt,
    fs::File,
    path::{Path, PathBuf},
    sync::Arc,
};

#[cfg(feature = "zip")]
use std::sync::Mutex;

/// An open archive, tagged by its format.
pub enum TypedArchive {
    /// Bethesda BSA/BA2 archive.
    #[cfg(feature = "beth-archives")]
    Bethesda(dream_archive::Archive),
    /// ZIP or PK3 archive.
    #[cfg(feature = "zip")]
    Zip(Mutex<zip::ZipArchive<File>>),
}

impl fmt::Debug for TypedArchive {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            #[cfg(feature = "beth-archives")]
            Self::Bethesda(_) => f.write_str("TypedArchive::Bethesda"),
            #[cfg(feature = "zip")]
            Self::Zip(_) => f.write_str("TypedArchive::Zip"),
        }
    }
}

/// An opened, heap-allocated archive together with its on-disk path.
#[derive(Debug)]
pub struct StoredArchive {
    /// Reserved for archive readers that require an external file handle.
    #[allow(dead_code)]
    pub(super) file_handle: Option<File>,
    pub(super) archive: TypedArchive,
    pub(super) path: PathBuf,
}

impl StoredArchive {
    /// Returns the typed archive handle.
    #[must_use]
    pub fn handle(&self) -> &TypedArchive {
        &self.archive
    }

    /// Returns the stored path to the archive file on disk.
    ///
    /// This is the path the archive was opened with; it is not canonicalized here.
    #[must_use]
    pub fn path(&self) -> &Path {
        &self.path
    }
}

/// Ordered list of open archive handles.
pub type ArchiveList = Vec<Arc<StoredArchive>>;