vfstool 0.9.0

A command-line tool for constructing, manipulating, and introspecting virtual file systems in Rust, based on OpenMW's VFS implementation.
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

// SPDX-License-Identifier: GPL-3.0-only
use std::{
    fs,
    io::{self, Write},
    path::{Path, PathBuf},
};

use vfstool_lib::{
    SerializeType, VFS, VFS_LOCK_SCHEMA_VERSION, VfsLock, serde, serde_json, serde_yaml,
    serialize_value, toml,
};

use crate::cli::OutputFormat;

pub fn write_serialized<T: serde::Serialize>(
    path: Option<PathBuf>,
    format: OutputFormat,
    value: &T,
) -> io::Result<()> {
    let serialized = serialize_value(value, output_to_serialize_type(format))?;
    match path {
        None => write_stdout(&serialized)?,
        Some(p) => {
            if let Some(parent) = p.parent()
                && !parent.as_os_str().is_empty()
            {
                fs::create_dir_all(parent).map_err(|e| {
                    io::Error::new(
                        e.kind(),
                        format!(
                            "failed to create output directory '{}': {e}",
                            parent.display()
                        ),
                    )
                })?;
            }
            write!(
                fs::File::create(&p).map_err(|e| io::Error::new(
                    e.kind(),
                    format!("failed to create output file '{}': {e}", p.display())
                ))?,
                "{serialized}"
            )?;
        }
    }
    Ok(())
}

pub fn parse_lock_file(path: &Path) -> io::Result<VfsLock> {
    let content = fs::read_to_string(path).map_err(|e| {
        io::Error::new(
            e.kind(),
            format!("failed to read lock file '{}': {e}", path.display()),
        )
    })?;
    let lock: VfsLock = match path.extension().and_then(std::ffi::OsStr::to_str) {
        Some("json") => serde_json::from_str(&content).map_err(|e| {
            io::Error::new(
                io::ErrorKind::InvalidData,
                format!("invalid JSON lock file '{}': {e}", path.display()),
            )
        }),
        Some("toml") => toml::from_str(&content).map_err(|e| {
            io::Error::new(
                io::ErrorKind::InvalidData,
                format!("invalid TOML lock file '{}': {e}", path.display()),
            )
        }),
        _ => serde_yaml::from_str(&content).map_err(|e| {
            io::Error::new(
                io::ErrorKind::InvalidData,
                format!("invalid YAML lock file '{}': {e}", path.display()),
            )
        }),
    }?;

    if lock.schema_version != VFS_LOCK_SCHEMA_VERSION {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            format!(
                "unsupported VFS lock schema_version {} in '{}'; expected {}",
                lock.schema_version,
                path.display(),
                VFS_LOCK_SCHEMA_VERSION
            ),
        ));
    }

    Ok(lock)
}

fn output_to_serialize_type(format: OutputFormat) -> SerializeType {
    match format {
        OutputFormat::Json => SerializeType::Json,
        OutputFormat::Yaml => SerializeType::Yaml,
        OutputFormat::Toml => SerializeType::Toml,
    }
}

pub fn write_serialized_vfs(
    path: Option<PathBuf>,
    format: OutputFormat,
    files: &vfstool_lib::DisplayTree,
) -> io::Result<()> {
    let serialized = VFS::serialize_from_tree(files, output_to_serialize_type(format))?;
    match path {
        None => write_stdout(&serialized)?,
        Some(path) => {
            if let Some(parent) = path.parent()
                && !parent.as_os_str().is_empty()
            {
                fs::create_dir_all(parent).map_err(|e| {
                    io::Error::new(
                        e.kind(),
                        format!(
                            "failed to create output directory '{}': {e}",
                            parent.display()
                        ),
                    )
                })?;
            }
            let mut file = fs::File::create(&path).map_err(|e| {
                io::Error::new(
                    e.kind(),
                    format!("failed to create output file '{}': {e}", path.display()),
                )
            })?;
            write!(file, "{serialized}")?;
        }
    }
    Ok(())
}

fn write_stdout(serialized: &str) -> io::Result<()> {
    let mut stdout = io::stdout().lock();
    match writeln!(stdout, "{serialized}") {
        Ok(()) => Ok(()),
        Err(e) if e.kind() == io::ErrorKind::BrokenPipe => Ok(()),
        Err(e) => Err(e),
    }
}