physis 0.5.0

Library for reading and writing FFXIV 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
62
63
64
65

// SPDX-FileCopyrightText: 2025 Joshua Goins <josh@redstrate.com>
// SPDX-License-Identifier: GPL-3.0-or-later

use std::path::PathBuf;

use crate::ByteBuffer;

use super::Resource;

/// Used to read unpacked files from a directory.
pub struct UnpackedResource {
    base_directory: String,
}

impl UnpackedResource {
    pub fn from_existing(base_directory: &str) -> Self {
        Self {
            base_directory: base_directory.to_string(),
        }
    }
}

impl Resource for UnpackedResource {
    fn read(&mut self, path: &str) -> Option<ByteBuffer> {
        let mut new_path = PathBuf::from(&self.base_directory);
        new_path.push(path.to_lowercase());

        std::fs::read(new_path).ok()
    }

    fn exists(&mut self, path: &str) -> bool {
        let mut new_path = PathBuf::from(&self.base_directory);
        new_path.push(path.to_lowercase());

        std::fs::exists(new_path).unwrap_or_default()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn common_setup_data() -> UnpackedResource {
        let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        d.push("resources/tests");

        UnpackedResource::from_existing(d.to_str().unwrap())
    }

    #[test]
    fn read_files() {
        let mut data = common_setup_data();

        assert!(data.read("empty_planlive.lgb").is_some());
        assert!(data.read("non_existent.lgb").is_none());
    }

    #[test]
    fn exist_files() {
        let mut data = common_setup_data();

        assert_eq!(data.exists("empty_planlive.lgb"), true);
        assert_eq!(data.exists("non_existent.lgb"), false);
    }
}