# GfArch
Rust crate for handling Good-Feel's [GfArch files](https://swiftshine.github.io/doc/gfa.html).

## Capabilities
### Archive Creation
- [X] Archives with Byte Pair Encoding
- [ ] Archives with LZ10

### Archive Extraction
- [X] Archives with Byte Pair Encoding
- [X] Archives with LZ10

## Usage
### Archive Creation
```rust
    // "archive_1" is now a GoodFeelArchive
    let archive_1 = gfarch::pack_from_files(
        &files,
        Version::V3,
        CompressionType::BPE,
        GFCPOffset::Default
    );

    // "archive_2" is now also a GoodFeelArchive
    let archive_2 = gfarch::pack_from_bytes(
        &byte_vectors,
        &filenames,
        Version::V3,
        CompressionType::BPE,
        GFCPOffset::Default
    );

```
### Archive Extraction
```rust
    let archive = fs::read("my_file.gfa")?;
    // "files" is now a collection of file data and filenames
    let files = gfarch::extract(&archive)?;
```