xc3_lib 0.21.0

Xenoblade Chronicles file format library
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
66
67
68
69
70
71
72
73

//! Error types for read and write operations.
use std::path::PathBuf;

use thiserror::Error;
use zune_inflate::errors::InflateDecodeErrors;

#[derive(Debug, Error)]
pub enum DecompressStreamError {
    #[error("error decoding compressed stream")]
    ZLib(#[from] InflateDecodeErrors),

    #[error("error reading stream data")]
    Io(#[from] std::io::Error),

    #[error("error reading stream data")]
    Binrw(#[from] binrw::Error),

    #[error("checksum verification failed")]
    Checksum(Vec<u8>),

    #[error("stream index {index} out of range for length {count}")]
    MissingStream { index: usize, count: usize },
}

#[derive(Debug, Error)]
#[error("error reading {path:?}")]
pub struct ReadFileError {
    pub path: PathBuf,
    #[source]
    pub source: binrw::Error,
}

#[derive(Debug, Error)]
pub enum ExtractStreamFilesError {
    #[error("error decompressing stream")]
    Stream(#[from] DecompressStreamError),

    #[error("error reading chr/tex texture")]
    ChrTexTexture(#[from] ReadFileError),

    #[error("legacy streams do not contain all necessary data")]
    LegacyStream,
}

#[derive(Debug, Error)]
pub enum CreateXbc1Error {
    #[error("error reading or writing data")]
    Io(#[from] std::io::Error),
}

#[derive(Debug, Error)]
pub enum CreateMtxtError {
    #[error("error swizzling surface")]
    SwizzleError(#[from] tegra_swizzle::SwizzleError),

    #[error("error creating surface from DDS")]
    DdsError(#[from] image_dds::error::SurfaceError),

    #[error("image format {0:?} is not supported by Mibl")]
    UnsupportedImageFormat(image_dds::ImageFormat),
}

#[derive(Debug, Error)]
pub enum CreateMiblError {
    #[error("error swizzling surface")]
    SwizzleError(#[from] tegra_swizzle::SwizzleError),

    #[error("error creating surface from DDS")]
    DdsError(#[from] image_dds::error::SurfaceError),

    #[error("image format {0:?} is not supported by Mibl")]
    UnsupportedImageFormat(image_dds::ImageFormat),
}