lsdj 0.1.1

Library for interfacing with LSDJ files and memory
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

//! Implementation of the [LSDJ compression algorithm](https://littlesounddj.fandom.com/wiki/File_Management_Structure)

mod compress;
mod decompress;
mod utils;

pub use compress::{CompressBlockError, compress_block};
pub use decompress::decompress_block;

/// The result of block compression/decompression
///
/// See [`compress_block`] and [`decompress_block`] for more information on when this is returned
#[derive(Debug, PartialEq, Eq)]
pub enum End {
    /// A block-jump command has been written/read
    JumpToBlock(u8),

    /// An EOF command has been written/read
    EndOfFile,
}