rd_helpdb/lib.rs
1//! Reader for installed R package help databases (aliases, `.rdx`/`.rdb`,
2//! and `Meta/hsearch.rds`), built on top of `rd-rds`.
3//!
4//! An installed package directory looks like:
5//!
6//! ```text
7//! <pkg_dir>/help/<pkg>.rdx # RDS file: index
8//! <pkg_dir>/help/<pkg>.rdb # concatenated binary records
9//! <pkg_dir>/help/aliases.rds # RDS: named character vector alias -> topic
10//! <pkg_dir>/Meta/hsearch.rds # RDS: help-search index
11//! ```
12//!
13//! `rd-helpdb` does not discover installed packages (R's `.libPaths()`
14//! logic is out of scope): [`PackageHelpDb::open`] takes an explicit
15//! package directory.
16
17mod db;
18mod error;
19mod index;
20mod rds;
21mod util;
22
23pub use db::PackageHelpDb;
24pub use error::Error;
25pub use rds::{decode_rdb_record, read_rds_file};