winereg 0.1.0

Rust library for parsing, writing, diffing, patching, and scripting Wine/Windows registry 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
66
67
68
69
70
71
72
73
74
75
76

use crate::{
    architecture::Architecture, registry_comparator::RegistryComparator, registry_key::KeyNode,
    registry_parser::{LoadResult, RegistryParser}, registry_writer::RegistryWriter,
};

/// Options for writing/serializing registry data.
#[derive(Debug, Clone)]
pub struct EditorOptions {
    pub relative_base: String,
    pub architecture: Architecture,
}

impl Default for EditorOptions {
    fn default() -> Self {
        Self {
            relative_base: String::new(),
            architecture: Architecture::Unknown,
        }
    }
}

/// Convenience facade mirroring KRegEdit's `RegistryEditor` object.
pub struct RegistryEditor;

impl RegistryEditor {
    /// Load a registry file from disk.
    pub fn load_from_file(filename: &str) -> Result<LoadResult, crate::registry_parser::ParseError> {
        let parser = RegistryParser;
        parser.load_from_file(filename)
    }

    /// Load a registry from an in-memory string.
    pub fn load_from_text(text: &str) -> Result<LoadResult, crate::registry_parser::ParseError> {
        let parser = RegistryParser;
        parser.load_from_text(text)
    }

    /// Write a registry tree to a file with the provided options.
    pub fn write_to_file_with_options(
        key: &KeyNode,
        filename: &str,
        options: EditorOptions,
    ) -> std::io::Result<()> {
        let writer = RegistryWriter {
            relative_base: options.relative_base,
            architecture: options.architecture,
        };
        writer.write_to_file(key, filename)
    }

    /// Convenience write with defaults (no relative base, unknown arch).
    pub fn write_to_file_default(key: &KeyNode, filename: &str) -> std::io::Result<()> {
        Self::write_to_file_with_options(key, filename, EditorOptions::default())
    }

    /// Serialize using options.
    pub fn write_to_string_with_options(key: &KeyNode, options: EditorOptions) -> String {
        let writer = RegistryWriter {
            relative_base: options.relative_base,
            architecture: options.architecture,
        };
        writer.write_to_string(key)
    }

    /// Shorthand with defaults (no relative base, unknown arch).
    pub fn write_to_string_default(key: &KeyNode) -> String {
        Self::write_to_string_with_options(key, EditorOptions::default())
    }

    /// Compare two registries and return the diff.
    pub fn compare_registries(key1: &KeyNode, key2: &KeyNode) -> crate::registry_comparator::DiffResult {
        let comparator = RegistryComparator;
        comparator.compare_registries(key1, key2)
    }
}