Crate squashfs_ng

source ·
Expand description

This crate provides Rust bindings for the squashfs-tools-ng library, providing support for SquashFS as an embeddable archive format without the need for kernel support. It also tries to provide a level of safety and abstraction on top of the C library. Cross-platform usability is a secondary goal.

§Installation

Currently, the underlying squashfs-tools-ng library must be installed on the system both to build and to use this library. The development headers (/usr/include/sqfs/...) are required to build, and the shared library (/usr/lib/libsquashfs.so) to run. The project’s GitHub page asserts that packages are available in many Linux distributions’ repositories.

Once the dependencies are in place, this should function like most other Rust libraries, and cargo build should suffice to build the library.

§Usage

The read and write modules below provide support for reading and writing SquashFS files, respectively. Check them out for further documentation.

Modules§

  • Facilities for reading SquashFS archives.
  • Facilities for writing SquashFS archives.

Enums§

  • Errors raised by the underlying library.
  • Errors encountered while reading or writing an archive.

Type Aliases§

  • Result type returned by SquashFS library operations.