Crate libruskel 

Ruskel generates skeletonized versions of Rust crates.

It produces a single-page, syntactically valid Rust code representation of a crate, with all implementations omitted. This provides a clear overview of the crate’s structure and public API.

Ruskel works by first fetching all dependencies, then using the nightly Rust toolchain to generate JSON documentation data. This data is then parsed and rendered into the skeletonized format. The skeletonized code is then formatted with rustfmt, and optionally has syntax highlighting applied.

You must have the nightly Rust toolchain installed to use (but not to install) Ruskel.

Re-exports

pub use crate::search::ListItem;

pub use crate::search::SearchDomain;

pub use crate::search::SearchIndex;

pub use crate::search::SearchItemKind;

pub use crate::search::SearchOptions;

pub use crate::search::SearchPathSegment;

pub use crate::search::SearchResponse;

pub use crate::search::SearchResult;

pub use crate::search::describe_domains;

pub use crate::search::parse_domain_token;

pub use crate::search::parse_domain_tokens;

Modules

highlight

Syntax highlighting functionality for Rust code.

search

Search and indexing utilities used by the CLI. Internal search index implementation.

toolchain

Shared nightly/rustup helpers.

Structs

Renderer

Configurable renderer that turns rustdoc data into skeleton Rust source.

Ruskel

Ruskel generates a skeletonized version of a Rust crate in a single page. It produces syntactically valid Rust code with all implementations omitted.

Enums

RuskelError

Errors surfaced while generating rustdoc skeletons.

Type Aliases

Result

Convenience alias for results returned by libruskel operations.