ltk_modpkg 0.5.0

League Toolkit mod package (.modpkg) reader/writer and utilities
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

use std::io::{Read, Seek};

use crate::{
    chunk::{NO_LAYER_INDEX, NO_WAD_INDEX},
    error::ModpkgError,
    Modpkg,
};

/// The path to the README.md chunk.
pub const README_CHUNK_PATH: &str = "_meta_/readme.md";

impl<TSource: Read + Seek> Modpkg<TSource> {
    /// Load the README.md chunk from the mod package.
    pub fn load_readme(&mut self) -> Result<Vec<u8>, ModpkgError> {
        let chunk = *self.get_chunk(README_CHUNK_PATH, None)?;

        if chunk.layer_index != NO_LAYER_INDEX || chunk.wad_index != NO_WAD_INDEX {
            return Err(ModpkgError::InvalidMetaChunk);
        }

        let data = self.load_chunk_decompressed(&chunk)?;

        Ok(data.into_vec())
    }
}