retrocompressor 1.0.1

//! # Retrocompressor Library
//! 
//! Compress or expand retro file formats
//! * `direct_ports::lzhuf` is a nearly direct port of `LZHUF` by Okumura et al.
//! * `lzss_huff` produces output compatible with `LZHUF` using a different implementation
//! * `lzw` performs LZW compression with various options
//! * `td0` converts between advanced (compressed) and normal (expanded) TD0 disk image formats
//! 
//! The compression/expansion functions are generics that operate on trait objects
//! with bounds `Read + Seek` or `Write + Seek`.  There are convenience functions for working
//! directly with buffers.
//! 
//! ## File Example
//! 
//! ```rs
//! use retrocompressor::*;
//! let mut in_file = std::fs::File::open("some_input_path").expect("open failed");
//! let mut out_file = std::fs::File::create("some_output_path").expect("create failed");
//! let (in_size,out_size) = lzss_huff::expand(&mut in_file,&mut out_file,&lzss_huff::STD_OPTIONS)
//!     .expect("expansion failed");
//! eprintln!("expanded {} into {}",in_size,out_size);
//! ```
//! 
//! ## Buffer Example
//! 
//! ```rs
//! use retrocompressor::*;
//! let test_data = "This is the chaunt of the priests.  The chaunt of the priests of Mung.".as_bytes();
//! let compressed = lzw::compress_slice(test_data,&lzw::STD_OPTIONS).expect("compression failed");
//! ```

mod tools;
pub mod lzw;
pub mod lzss_huff;
pub mod td0;
pub mod direct_ports;

type DYNERR = Box<dyn std::error::Error>;

#[derive(thiserror::Error,Debug)]
pub enum Error {
    #[error("file format mismatch")]
    FileFormatMismatch,
    #[error("file too large")]
    FileTooLarge,
    #[error("checksum failed")]
    BadChecksum
}

#[derive(Clone)]
pub enum BitOrder {
    Msb0,
    Lsb0
}