Struct public_api::PublicApi

#[non_exhaustive]
pub struct PublicApi {
    pub items: Vec<PublicItem>,
    pub missing_item_ids: Vec<String>,
}

Return type of public_api_from_rustdoc_json_str.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

items: Vec<PublicItem>

The items that constitutes the public API. An “item” is for example a function, a struct, a struct field, an enum, an enum variant, a module, etc…

missing_item_ids: Vec<String>

The rustdoc JSON IDs of missing but referenced items. Intended for use with --verbose flags or similar.

In some cases, a public item might be referenced from another public item (e.g. a mod), but is missing from the rustdoc JSON file. This occurs for example in the case of re-exports of external modules (see https://github.com/Enselic/cargo-public-api/issues/103). The entries in this Vec are what IDs that could not be found.

The exact format of IDs are to be considered an implementation detail and must not be be relied on.

Trait Implementations

impl Debug for PublicApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.