lunar-image 1.0.0

LIF (.li) — lossless image format with planar layout, delta filter, and zstd compression
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

use thiserror::Error;

/// errors that can occur when decoding a .li image.
///
/// covers header validation, chunk parsing, and decompression failures.
#[derive(Debug, Error)]
pub enum DecodeError {
	#[error("file too short for header")]
	TruncatedHeader,

	#[error("invalid magic bytes: expected LIF, got {0:?}")]
	InvalidMagic([u8; 4]),

	#[error("unsupported format version: {0}")]
	UnsupportedVersion(u16),

	#[error("unknown flag bits set: {0:#06x}")]
	UnknownFlags(u16),

	#[error("missing required pixel data chunk")]
	MissingPixelData,

	#[error("multiple pixel data chunks")]
	MultiplePixelData,

	#[error("pixel data size mismatch: expected {expected}, got {actual}")]
	SizeMismatch { expected: usize, actual: usize },

	#[error("zstd decompression failed: {0}")]
	ZstdError(#[from] std::io::Error),

	#[error("unexpected end of file")]
	TruncatedChunk,
}

/// errors that can occur when encoding a .li image.
///
/// covers dimension validation, pixel buffer validation, and compression failures.
#[derive(Debug, Error)]
pub enum EncodeError {
	#[error("image dimensions too large: {width}x{height}")]
	DimensionsTooLarge { width: u32, height: u32 },

	#[error("pixel buffer size mismatch: expected {expected}, got {actual}")]
	BufferSizeMismatch { expected: usize, actual: usize },

	#[error("zstd compression failed: {0}")]
	ZstdError(#[from] std::io::Error),
}