unity-formats 0.2.1

Reads Unity games' data files: SerializedFiles, scenes, meshes, textures, shader programs and Animator data
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

allow-unwrap-in-tests = true
allow-expect-in-tests = true

# File, environment and process access. The crate denies these (`#![deny(clippy::disallowed_methods,
# clippy::disallowed_types)]` in src/lib.rs); the two modules that read a player's files opt back in with an
# `#![allow(..., reason = ...)]` (src/player.rs, src/resource.rs). Everything else works on bytes it is given
# (CONTRIBUTING.md, "File access").
disallowed-methods = [
    { path = "std::fs::read", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::read_to_string", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::read_dir", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::write", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::copy", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::rename", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::create_dir", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::create_dir_all", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::remove_file", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::remove_dir", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::remove_dir_all", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::metadata", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::symlink_metadata", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::canonicalize", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::exists", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::try_exists", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::is_file", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::is_dir", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::metadata", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::read_dir", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::canonicalize", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::absolute", reason = "reads the working directory: not in library code (CONTRIBUTING.md, File access)" },
    { path = "std::env::var", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::var_os", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::vars", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::current_dir", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::process::Command::new", reason = "no processes in library code (CONTRIBUTING.md, File access)" },
    { path = "std::fs::exists", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::read_link", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::hard_link", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::set_permissions", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::soft_link", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::os::unix::fs::symlink", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)", allow-invalid = true },
    { path = "std::path::Path::read_link", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::path::Path::is_symlink", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::env::args", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::args_os", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::temp_dir", reason = "reads the environment (the temporary folder): not in library code (CONTRIBUTING.md, File access)" },
    { path = "std::env::home_dir", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::set_current_dir", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::set_var", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::remove_var", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::env::vars_os", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
    { path = "std::process::exit", reason = "no processes in library code (CONTRIBUTING.md, File access)" },
    { path = "std::process::abort", reason = "no processes in library code (CONTRIBUTING.md, File access)" },
    { path = "std::io::stdin", reason = "hidden options: the caller passes them (CONTRIBUTING.md, File access)" },
]
disallowed-types = [
    { path = "std::fs::File", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::OpenOptions", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::fs::DirBuilder", reason = "file access: only the modules that read a player's files (CONTRIBUTING.md, File access)" },
    { path = "std::process::Command", reason = "no processes in library code (CONTRIBUTING.md, File access)" },
]