Enum Error 

pub enum Error {
    InvalidParentIndex {
        context: String,
        index: u32,
    },
    UnknownCompressionType {
        value: u32,
        context: String,
    },
    InvalidCompressedFileOffset {
        compressed_file_offset_found: u64,
    },
    InvalidFooterLength {
        footer_length_found: usize,
        footer_offset_found: usize,
        num_bytes: usize,
    },
    InvalidFooterOffset {
        footer_offset_found: u64,
    },
    Lz4DecompressionFailed {
        context: String,
        error: DecompressError,
        compressed_length: usize,
        decompressed_length: usize,
    },
    NumberOfEntriesTooHigh {
        context: String,
        value: u64,
        bit_width: u32,
    },
    CompressedFileSizeTooHigh {
        context: String,
        value: u64,
        bit_width: u32,
    },
    DecompressedFileSizeTooHigh {
        context: String,
        value: u64,
        bit_width: u32,
    },
    CompressedMetadataSizeTooHigh {
        context: String,
        value: u64,
        bit_width: u32,
    },
    StringLengthTooHigh {
        context: String,
        value: u64,
        bit_width: u32,
    },
    IndexTooHigh {
        context: String,
        value: u32,
        bit_width: u32,
    },
    InvalidIdentifier {
        expected_bytes: [u8; 4],
        bytes_found: [u8; 4],
    },
    InvalidModInfoAttributeCount {
        found: usize,
    },
    InvalidMetadataFile {
        context: String,
    },
    MissingModInfoFolder,
    MissingModInfoMd5,
    MissingModInfoName,
    MissingModInfoPublishHandle,
    MissingModInfoUuid,
    MissingModInfoVersion,
    Io {
        context: String,
        inner: Error,
    },
    MissingAttributeValue {
        name: &'static str,
    },
    MissingLspkFileInZip,
    MissingMetadataFile,
    MissingModuleInfo,
    ParseIntError {
        inner: ParseIntError,
        location: &'static str,
    },
    TableEntryDecompressionFailed(DecompressError),
    TooShort,
    UnsupportedVersion {
        version_number_found: u32,
    },
    UnsupportedModPath(PathBuf),
    UnableToReadZipFile(Error),
    ZlibDecompressionFailed {
        path: PathBuf,
        error: Error,
    },
    ZstdDecompressionFailed {
        path: PathBuf,
        error: String,
    },
    ZstdNotSupported,
    XmlDeserialize(DeError),
    XmlSerialize(SeError),
    XmlWrite(Error),
    LsfXmlMissingField {
        attribute_id: String,
        field: &'static str,
    },
    LsfXmlUnknownType {
        attribute_id: String,
        type_name: String,
    },
    LsfXmlWrongComponentCount {
        attribute_id: String,
        expected: usize,
        found: usize,
    },
    LsfXmlParse {
        attribute_id: String,
        expected_type: String,
        value: String,
        inner: String,
    },
    LsfXmlDecodeBase64 {
        attribute_id: String,
        inner: DecodeError,
    },
}

Errors that can occur when processing BG3 files.

Variants

InvalidParentIndex

The parent index specified in the .lsf file was not found when parsing the file.

Fields

context: String

index: u32

UnknownCompressionType

The compression type specified in the file is not supported.

Fields

value: u32

context: String

InvalidCompressedFileOffset

Fields

compressed_file_offset_found: u64

InvalidFooterLength

The footer that should contain metadata did not properly indicate its length.

Fields

footer_length_found: usize

footer_offset_found: usize

num_bytes: usize

InvalidFooterOffset

The offset to the footer didn’t correctly point to a location in the file.

Fields

footer_offset_found: u64

Lz4DecompressionFailed

Unable to decompress a file.

Fields

context: String

error: DecompressError

compressed_length: usize

decompressed_length: usize

NumberOfEntriesTooHigh

The number of entries in the file is too high to fit into a the given integer width.

Fields

context: String

value: u64

bit_width: u32

CompressedFileSizeTooHigh

The compressed size of the file is too large to fit into a the given integer width.

Fields

context: String

value: u64

bit_width: u32

DecompressedFileSizeTooHigh

The decompressed size of the file is too large to fit into a the given integer width.

Fields

context: String

value: u64

bit_width: u32

CompressedMetadataSizeTooHigh

The compressed size of the metadata is too large to fit into a the given integer width.

Fields

context: String

value: u64

bit_width: u32

StringLengthTooHigh

The length of

Fields

context: String

value: u64

bit_width: u32

IndexTooHigh

The index of the entry is too large to fit into the given integer width.

Fields

context: String

value: u32

bit_width: u32

InvalidIdentifier

The “magic number” used to identify the type of file didn’t match the expected value.

Fields

expected_bytes: [u8; 4]

bytes_found: [u8; 4]

InvalidModInfoAttributeCount

The number of attributes in the mod info section doesn’t match the expected count of 6.

Fields

found: usize

InvalidMetadataFile

A meta.lsx file was found within an LSPK .pak archive that didn’t match the expected XML format.

Fields

context: String

MissingModInfoFolder

The mod info section is missing the "Folder" attribute.

MissingModInfoMd5

The mod info section is missing the "MD5" attribute.

MissingModInfoName

The mod info section is missing the "Name" attribute.

MissingModInfoPublishHandle

The mod info section is missing the "PublishHandle" attribute.

MissingModInfoUuid

The mod info section is missing the "UUID" attribute.

MissingModInfoVersion

The mod info section is missing the "Version" attribute.

Io

An I/O error occured.

Fields

context: String

inner: Error

MissingAttributeValue

The attribute with the given name was not found.

Fields

name: &'static str

MissingLspkFileInZip

No meta.lsx file was found in an LSPK .pak file. A zipfile didn’t contain any file with the .pak extension.

MissingMetadataFile

No meta.lsx file was found in the LSPK file.

MissingModuleInfo

The LSX file is missing the required "ModuleInfo" node.

ParseIntError

The an integer value could not be parsed from the LSX file at the given location.

Fields

inner: ParseIntError

location: &'static str

TableEntryDecompressionFailed(DecompressError)

An error occurred when trying to parse the path of a file within an LSPK .pak archive.

TooShort

The file being read was too short to contain all of the expected metadata of the given format.

UnsupportedVersion

The version number read when parsing the file was lower than the minimum supported version.

Fields

version_number_found: u32

UnsupportedModPath(PathBuf)

The path isn’t supported for packing from.

UnableToReadZipFile(Error)

Available on crate feature zip only.

An error occured when trying to read the data from a zipfile.

ZlibDecompressionFailed

Unable to decompress a file.

Fields

path: PathBuf

error: Error

ZstdDecompressionFailed

Fields

path: PathBuf

error: String

ZstdNotSupported

The file contains zstd-compressed data, but this tool does not currently support it.

XmlDeserialize(DeError)

The LSX data could not be parsed.

XmlSerialize(SeError)

The LSX data could not be serialized.

XmlWrite(Error)

The LSX data could not be written to a file.

LsfXmlMissingField

LSF attribute is missing a required field.

Fields

attribute_id: String

field: &'static str

LsfXmlUnknownType

LSF value has an unknown type.

Fields

attribute_id: String

type_name: String

LsfXmlWrongComponentCount

LSF value has the wrong number of components.

Fields

attribute_id: String

expected: usize

found: usize

LsfXmlParse

LSF value failed to parse.

Fields

attribute_id: String

expected_type: String

value: String

inner: String

LsfXmlDecodeBase64

LSF value failed to decode base64.

Fields

attribute_id: String

inner: DecodeError

Implementations

impl Error

pub fn custom_io(context: impl Display, inner: Error) -> Self

pub fn read_io(context: impl Display, inner: Error) -> Self

pub fn write_io(context: impl Display, inner: Error) -> Self

Trait Implementations

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DeError> for Error

fn from(source: DeError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SeError> for Error

fn from(source: SeError) -> Self

Converts to this type from the input type.