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

use super::*;

#[test]
fn candidate_plan_reports_additions_and_conflicts() {
    let low = TempDir::new("analysis_plan_low");
    let high = TempDir::new("analysis_plan_high");
    let candidate = TempDir::new("analysis_plan_candidate");

    low.write("textures/a.dds", b"low");
    high.write("textures/a.dds", b"high");
    high.write("textures/b.dds", b"b");

    candidate.write("textures/a.dds", b"candidate-new");
    candidate.write("textures/c.dds", b"c");

    let (vfs, index) = VFS::from_directories_with_layer_index([low.path(), high.path()], None);
    let plan = index
        .plan_candidate_directory(&vfs, candidate.path(), CandidatePlanOpts::default())
        .expect("candidate plan should succeed");

    assert_eq!(plan.summary.additions, 1);
    assert_eq!(plan.summary.conflicts, 1);
    assert_eq!(plan.summary.displaced_winners, 1);
    assert_eq!(plan.additions[0], PathBuf::from("textures/c.dds"));
    assert_eq!(plan.conflicts[0].key, PathBuf::from("textures/a.dds"));
    assert_eq!(plan.conflicts[0].semantic_differs, Some(true));
}

#[test]
fn candidate_plan_semantic_can_be_disabled() {
    let base = TempDir::new("analysis_plan_semantic_base");
    let candidate = TempDir::new("analysis_plan_semantic_candidate");
    base.write("textures/a.dds", b"same");
    candidate.write("textures/a.dds", b"same");

    let (vfs, index) = VFS::from_directories_with_layer_index([base.path()], None);
    let plan = index
        .plan_candidate_directory(
            &vfs,
            candidate.path(),
            CandidatePlanOpts {
                include_semantic: false,
            },
        )
        .expect("candidate plan should succeed");

    assert_eq!(plan.conflicts.len(), 1);
    assert_eq!(plan.conflicts[0].semantic_differs, None);
}

#[test]
fn candidate_plan_deduplicates_normalized_candidate_keys() {
    let base = TempDir::new("analysis_plan_dedupe_base");
    let candidate = TempDir::new("analysis_plan_dedupe_candidate");
    base.write("textures/a.dds", b"base");
    candidate.write("textures/a.dds", b"candidate-lower");
    candidate.write("Textures/A.dds", b"candidate-upper");
    candidate.write("meshes/b.nif", b"candidate-lower");
    candidate.write("Meshes/B.nif", b"candidate-upper");

    let (vfs, index) = VFS::from_directories_with_layer_index([base.path()], None);
    let plan = index
        .plan_candidate_directory(&vfs, candidate.path(), CandidatePlanOpts::default())
        .expect("candidate plan should succeed");

    assert_eq!(plan.summary.additions, 1);
    assert_eq!(plan.summary.conflicts, 1);
    assert_eq!(plan.summary.displaced_winners, 1);
    assert_eq!(plan.additions, vec![PathBuf::from("meshes/b.nif")]);
    assert_eq!(plan.conflicts.len(), 1);
    assert_eq!(plan.conflicts[0].key, PathBuf::from("textures/a.dds"));
}