Struct Parser 

pub struct Parser;

Parser for rustdoc JSON files.

Provides methods to load and parse rustdoc JSON from files or strings into the rustdoc_types::Crate structure.

Implementations

impl Parser

pub fn parse_json(json: &str) -> Result<Crate, Error>

Parse a rustdoc JSON file from disk into a Crate structure.

This is the primary entry point for loading documentation data. The file should be generated with cargo doc --output-format json. Parse a JSON string into a Crate structure.

Errors

Returns an error if it faills to parse the JSON.

pub fn parse_file(path: impl AsRef<Path>) -> Result<Crate, Error>

Parse a JSON file.

Errors

Returns error if fails to read the JSON file.

pub fn parse_json_string(content: &str) -> Result<Crate, Error>

Parse a rustdoc JSON string into a Crate structure.

This function is useful when the JSON content is already in memory (e.g., fetched from a URL or embedded in tests).

Arguments

• content - The raw JSON string to parse

Returns

A parsed Crate structure containing all documentation data.

Errors

Returns Error::JsonParse if the JSON is invalid or doesn’t match the expected rustdoc JSON schema.

Schema Compatibility

The rustdoc-types crate version must match the rustdoc JSON format version. Mismatches can cause parsing failures or missing fields.