esplugin 6.1.4

A free software library for reading Elder Scrolls plugin (.esp/.esm/.esl) files.
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

#![allow(clippy::missing_assert_message, clippy::unwrap_used)]
use std::path::Path;

use criterion::Criterion;
use esplugin::{GameId, ParseOptions, Plugin};

// HearthFires.esm is a 3.8 MB file, so it's got plenty of content without being
// large enough to slow down benchmarking much.
// NOTE: This plugin isn't shipped in testing-plugins, it needs to be copied
// from Skyrim SE.
const PLUGIN_TO_PARSE: &str = "testing-plugins/SkyrimSE/Data/HearthFires.esm";
const GAME_ID: GameId = GameId::SkyrimSE;

fn criterion_benchmark(c: &mut Criterion) {
    c.bench_function("Plugin.parse_file() header-only", |b| {
        let mut plugin = Plugin::new(GAME_ID, Path::new(PLUGIN_TO_PARSE));

        b.iter(|| {
            plugin.parse_file(ParseOptions::header_only()).unwrap();
        });
    });

    c.bench_function("Plugin.parse_file() full", |b| {
        let mut plugin = Plugin::new(GAME_ID, Path::new(PLUGIN_TO_PARSE));

        b.iter(|| {
            plugin.parse_file(ParseOptions::whole_plugin()).unwrap();
        });
    });

    c.bench_function("Plugin.overlaps_with()", |b| {
        let mut plugin = Plugin::new(GAME_ID, Path::new(PLUGIN_TO_PARSE));

        plugin.parse_file(ParseOptions::whole_plugin()).unwrap();

        b.iter(|| {
            assert!(plugin.overlaps_with(&plugin).unwrap());
        });
    });

    c.bench_function("Plugin.count_override_records()", |b| {
        let mut plugin = Plugin::new(GAME_ID, Path::new(PLUGIN_TO_PARSE));

        plugin.parse_file(ParseOptions::whole_plugin()).unwrap();

        b.iter(|| {
            assert_eq!(plugin.count_override_records().unwrap(), 1272);
        });
    });

    c.bench_function("Plugin.is_master_file()", |b| {
        let mut plugin = Plugin::new(
            GAME_ID,
            Path::new("testing-plugins/SkyrimSE/Data/Blank.esp"),
        );
        plugin.parse_file(ParseOptions::header_only()).unwrap();

        b.iter(|| {
            assert!(!plugin.is_master_file());
        });
    });
}

criterion::criterion_group!(benches, criterion_benchmark);
criterion::criterion_main!(benches);