silpkg

Crates.iosilpkg
lib.rssilpkg
version
sourcesrc
created_at2024-12-08 15:37:09.245119
updated_at2024-12-08 15:37:09.245119
descriptionA library for working with SIL's PKG archives
homepage
repositoryhttps://github.com/afishhh/silpkg
max_upload_size
id1476375
Cargo.toml error:TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Hubert GÅ‚uchowski (afishhh)

documentation

README

silpkg

silpkg is a library for interacting with SIL PKG files.

Documentation for the library can be generated through rustdoc (cargo doc). The main entry point to the library is silpkg::sync::Pkg which allows for reading and writing archives backed by a Read + Seek (+ Write (+ silpkg::sync::Truncate)) type.

CLI

A CLI that allows performing basic operations on archives is also included and can be easily installed with cargo install --git https://github.com/afishhh/silpkg cli.

MSRV

Nightly rust is required to use this library. This is because I experimented with using Rust's Coroutines for IO agnostic parsing logic.

no_std

While the crate will build without std, it still depends on alloc and since std::io is absent the only way to actually use the library is through the silpkg::base module with the unstable_base feature. Theoretically a slice-backed Pkg could be implemented to allow for easy no_std use, although currently I have too little time (and see little reason) to do this myself. For implementing your own IO frontend for the silpkg::base module, look at how silpkg::sync::Pkg is currently implemented.

Commit count: 38

cargo fmt