modcrawl 0.4.0

Detect, inspect, and analyze Minecraft mods and plugins from JAR 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

use std::io::Read;
use std::path::Path;

use zipcrawl::ZipManager;

use crate::core::detect_mod_type::ModType;
use crate::error::Result;

/// Detect the mod/plugin type from a JAR file on disk.
///
/// # Errors
///
/// Returns an error if the file cannot be read or is not a valid ZIP archive.
pub fn identify(path: &Path) -> Result<ModType> {
    let mut mng = ZipManager::new(path)?;
    let entries = mng.entries()?;
    Ok(super::REGISTRY.detect(&entries))
}

/// Detect the mod/plugin type from a ZIP archive read via a `Read` impl.
///
/// # Errors
///
/// Returns an error if the data cannot be read or is not a valid ZIP archive.
pub fn identify_reader<R: Read>(reader: &mut R) -> Result<ModType> {
    let mut mng = ZipManager::from_reader(reader)?;
    let entries = mng.entries()?;
    Ok(super::REGISTRY.detect(&entries))
}