ltk_meta 0.9.1

Metadata formats and utilities for League Toolkit
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
74

use ltk_hash::{BinHash, HashWidth};
use miette::Diagnostic;

use super::property::Kind;
use crate::{path::PropertyPathError, BinKind};

#[derive(Debug, thiserror::Error, Diagnostic)]
#[non_exhaustive]
pub enum Error {
    #[error("Invalid file signature")]
    InvalidFileSignature,
    #[error("Invalid file version '{0}'")]
    InvalidFileVersion(u32),
    #[error("Expected a {expected} bin, found a {found} bin")]
    UnexpectedBinKind { expected: BinKind, found: BinKind },
    #[error("Invalid PTCH version '{0}' - the client only accepts 1")]
    InvalidOverrideVersion(u32),
    #[error("The PTCH declares {0} dependencies - a patch that has any cannot be loaded")]
    OverrideDependencies(u32),
    #[error("Invalid property path in patch record {index} (object {object_hash:08x}) - {source}")]
    InvalidPropertyPath {
        index: usize,
        object_hash: BinHash,
        #[source]
        source: PropertyPathError,
    },
    #[error("Invalid '{0}' - got '{1}'")]
    InvalidField(&'static str, String),
    #[error("Invalid property kind - {0}")]
    InvalidPropertyTypePrimitive(#[from] num_enum::TryFromPrimitiveError<Kind>),
    #[error("Invalid size - expected {0}, got {1} bytes")]
    InvalidSize(u64, u64),

    #[error("Container type {0:?} cannot be nested!")]
    InvalidNesting(Kind),
    #[error("Invalid map key type {0:?}, only primitive types can be used as keys.")]
    InvalidKeyType(Kind),

    #[error("Container is empty!")]
    EmptyContainer,
    #[error("Mismatched types - expected {expected:?}, got {got:?}")]
    MismatchedContainerTypes { expected: Kind, got: Kind },
    #[error(
        "A hash value has a width of {} bytes. The other hash values of its container or map side \
         have a width of {} bytes. Use the same width for all hash items of a container, all hash \
         keys of a map and all hash values of a map",
        got.bytes(),
        expected.bytes()
    )]
    MismatchedHashWidths { expected: HashWidth, got: HashWidth },
    #[error(
        "Cannot resolve the hash widths of a map. Its size is valid for 4-byte keys with 8-byte \
         values and for 8-byte keys with 4-byte values. Write the hash keys and the hash values of \
         the map with the same width"
    )]
    AmbiguousHashWidth,

    #[error(
        "Cannot write a delta over a bin read with the legacy property kind numbering. \
         Transcode it with BinStream::into_bin and Bin::to_writer"
    )]
    DeltaLegacyNumbering,
    #[error("The delta names object {0:08x}, which the base bin does not hold")]
    DeltaMissingObject(BinHash),
    #[error("The delta appends object {0:08x}, which the written bin also holds")]
    DeltaDuplicateObject(BinHash),

    #[error(transparent)]
    ReaderError(#[from] ltk_io_ext::ReaderError),
    #[error("IO Error - {0}")]
    IOError(#[from] std::io::Error),
    #[error("UTF-8 Error - {0}")]
    Utf8Error(#[from] std::str::Utf8Error),
}