docs.rs failed to build opticaldiscs-0.10.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

opticaldiscs

Format-agnostic optical disc image reading and filesystem browsing for Rust.

Provides a unified SectorReader abstraction that handles the cooked/raw sector translation across container formats — ISO, BIN/CUE, CHD, CloneCD, Nero (NRG), Alcohol 120% (MDS/MDF), DiscJuggler (CDI), DAEMON Tools (MDX), PSP CSO, gzip, and Nintendo (GameCube/Wii) — with filesystem browsers for ISO 9660, UDF, HFS/HFS+, SGI EFS, and many more on top.

Status: Published on crates.io. Disc reading, detection, and filesystem browsing are complete and in production use; physical-disc ripping is the next milestone. See PLAN.md for the roadmap.

CHD support

opticaldiscs-rs reads CHD optical images via libchdman-rs, which wraps MAME's official chd_file core. This provides byte-for-byte parity with the chdman tool — including subcode handling, audio byte-swapping, and per-track frame semantics — at the cost of needing to link MAME's C++ code.

By default, opticaldiscs-rs enables libchdman-rs's prebuilt feature, which downloads a pre-built static archive matching the build target from libchdman-rs's GitHub Releases instead of compiling MAME from source. This keeps CI build times in seconds, not minutes.

When you might need to override prebuilt behavior

Situation	Set env var
Target triple isn't covered by libchdman-rs's prebuilt matrix	`LIBCHDMAN_PREBUILT_FALLBACK=1`
Local development without network access	`LIBCHDMAN_FORCE_SOURCE=1`
Linux: pick a specific glibc floor for the prebuilt archive	`LIBCHDMAN_GLIBC=2.31` (or `2.35`, `2.39`)

See libchdman-rs's README for the full list of supported targets, glibc floors, and escape hatches.

Features

Capability	Status
ISO sector reader	✓
BIN/CUE sector reader (raw 2352-byte)	✓
CHD sector reader (via libchdman-rs)	✓
PSP `.cso` (CISOv1) + gzip-compressed (`.gz`) image readers	✓ (since 0.9.0)
CloneCD (`.ccd` / `.img` / `.sub`) container	✓ (since 0.9.0)
Nero (`.nrg`) container	✓ (since 0.9.0)
Alcohol 120% (`.mds` / `.mdf`) container	✓ (since 0.9.0)
DiscJuggler (`.cdi`) container — incl. Dreamcast GD-ROM absolute-LBA rebasing	✓ (since 0.9.0)
DAEMON Tools (`.mdx`) container — encrypted + zlib-compressed descriptor	✓ (`mdx` feature, since 0.9.0)
Disc format + filesystem auto-detection	✓
ISO 9660 filesystem browser	✓
ISO 9660 PVD date/time metadata (creation/modification/expiration/effective)	✓ (since 0.4.4)
Joliet (Unicode long names)	✓ (since 0.6.0)
Rock Ridge / SUSP (POSIX metadata, long names, symlinks, timestamps)	✓ (since 0.6.0)
Per-file timestamps + POSIX ownership on `FileEntry` (all filesystems)	✓ (since 0.6.0)
High Sierra Format browser (pre-ISO 9660 `CDROM` discs)	✓ (since 0.7.0)
Raw 2352-byte-sector auto-detect in a bare `.iso`	✓ (since 0.7.0)
HFS / HFS+ filesystem browser	✓
SGI Volume Header + EFS filesystem browser (IRIX CDs)	✓ (since 0.3.0)
UFS1 / FFS browser — Digital UNIX/Tru64, SunOS; NeXT/OpenStep/Rhapsody	✓ (since 0.7.0)
VMS ODS-2 / Files-11 browser (OpenVMS VAX/Alpha)	✓ (since 0.7.0)
UDF browser — DVD / data discs (physical partition, UDF 1.02–2.01)	✓ (since 0.7.0)
UDF 2.50+ metadata-partition browser (Blu-ray / BDMV discs)	✓ (since 0.8.0)
Game-disc identification — console + serial/title/region (PS1/PS2, Saturn, Mega-CD, Dreamcast, PC-FX, PC Engine CD, CD32, Neo Geo CD, 3DO, CD-i, GameCube, Wii)	✓ (since 0.8.0)
GameCube & Wii filesystem browser (ISO/GCM, RVZ/WIA, WBFS, CISO, GCZ, TGC; Wii decryption — via `nod`)	✓ (since 0.8.0)
Dreamcast GD-ROM browser — high-density area (CHD + `.gdi`)	✓ (since 0.8.0)
Philips CD-i (Green Book) filesystem browser	✓ (since 0.8.0)
3DO Opera filesystem browser	✓ (since 0.8.0)
TOC + MusicBrainz/FreeDB DiscID	✓ (`toc` feature)
Physical optical drive enumeration	✓ (`drives` feature)

Quick Example

use opticaldiscs::detect::DiscImageInfo;
use opticaldiscs::browse;

let info = DiscImageInfo::open("disc.iso")?;
println!("Volume: {:?}", info.volume_label);
println!("Filesystem: {}", info.filesystem.display_name());

let mut fs = browse::open_disc_filesystem(&info)?;
let root = fs.root()?;
for entry in fs.list_directory(&root)? {
    println!("{:<40} {}", entry.name, entry.size_string());
}

Cargo.toml

opticaldiscs = "0.9"

# with optional features
opticaldiscs = { version = "0.9", features = ["toc", "drives", "mdx"] }

To track unreleased changes, depend on the git repository instead:

opticaldiscs = { git = "https://github.com/danifunker/opticaldiscs-rs" }

Feature Flags

Flag	Enables	Extra deps
`toc`	`DiscTOC`, MusicBrainz DiscID, FreeDB ID	`sha1`, `base64`
`drives`	`list_drives()` — enumerate physical optical drives	—
`mdx`	DAEMON Tools `.mdx` browsing (its descriptor is always AES-256-encrypted + zlib-compressed)	`aes`, `pbkdf2`, `ripemd`

Without the mdx feature, .mdx files are still recognised (DiscFormat::Mdx) but report as unbrowsable rather than pulling in the crypto stack.

Used By

rusty-backup — vintage disc backup/restore tool
ODE-artwork-downloader — USBODE cover art downloader

License

GPL-3.0 — see LICENSE.

opticaldiscs 0.10.0