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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

// SPDX-License-Identifier: GPL-3.0-only
//! Report types returned by the conflict, shadowed, provider, and diff subcommands.
use std::path::PathBuf;

// --- Collapse ---

/// Options that control how [`VFS::collapse_into`](crate::vfs::VFS::collapse_into)
/// links or copies files.
pub struct CollapseOptions {
    /// Fall back to copying when hardlinking fails.
    pub allow_copying: bool,
    /// Extract supported archive entries as loose files.
    ///
    /// With archive features enabled, this covers BSA/BA2 (`beth-archives`) and ZIP/PK3 (`zip`).
    /// Configured loose archive files are skipped so the output does not contain both an archive and
    /// its extracted contents.
    pub extract_archives: bool,
    /// Use symbolic links instead of hard links (allows cross-device linking).
    pub use_symlinks: bool,
}

// --- Conflicts ---

/// Full conflicts report listing every source's overrides and overridden-by files.
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
pub struct ConflictsReport {
    /// Per-source conflict entries, in load-order position.
    pub sources: Vec<ConflictSourceEntry>,
}

/// Conflict information for a single source directory or archive.
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
pub struct ConflictSourceEntry {
    /// Absolute path to the source directory or archive.
    pub path: PathBuf,
    /// VFS paths where this source overrides at least one earlier (lower-priority) source.
    pub overrides: Vec<PathBuf>,
    /// VFS paths where this source is overridden by at least one later (higher-priority) source.
    pub overridden_by: Vec<PathBuf>,
}

// --- Shadowed ---

/// Report listing sources whose files are entirely overridden by higher-priority sources.
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
pub struct ShadowedReport {
    /// Fully shadowed sources.
    pub sources: Vec<ShadowedSource>,
}

/// A single source whose files are all shadowed by higher-priority sources.
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
pub struct ShadowedSource {
    /// Absolute path to the source directory or archive.
    pub path: PathBuf,
    /// VFS paths of all files in this source, each overridden by a later source.
    ///
    /// This is empty for summary reports built without file listings.
    #[cfg_attr(feature = "serialize", serde(skip_serializing_if = "Vec::is_empty"))]
    pub shadowed_files: Vec<PathBuf>,
}

// --- Diff ---

/// Comparison report between two source directories.
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
pub struct DiffReport {
    /// Absolute path to the first source directory.
    pub source_a: PathBuf,
    /// Absolute path to the second source directory.
    pub source_b: PathBuf,
    /// Whichever of `source_a` or `source_b` has higher load-order priority.
    pub higher_priority: PathBuf,
    /// Slash-separated VFS keys present in both sources.
    pub shared: Vec<String>,
    /// Slash-separated VFS keys present only in `source_a`.
    pub only_in_a: Vec<String>,
    /// Slash-separated VFS keys present only in `source_b`.
    pub only_in_b: Vec<String>,
}