Struct DocIndex 

pub struct DocIndex { /* private fields */ }

Searchable index of all documented items across one or more crates.

Implementations

impl DocIndex

pub fn new() -> Self

Create an empty index.

pub fn add(&mut self, item: DocItem) -> Result<(), KernelError>

Add an item to the index.

pub fn len(&self) -> usize

Number of indexed items.

pub fn is_empty(&self) -> bool

Whether the index is empty.

pub fn search_by_name(&self, query: &str) -> Vec<&DocItem>

Search by name substring (case-insensitive).

pub fn search_by_path(&self, prefix: &str) -> Vec<&DocItem>

Search by fully-qualified path prefix.

pub fn statistics(&self) -> DocIndexStats

Return counts per item kind.

Trait Implementations

impl Clone for DocIndex

fn clone(&self) -> DocIndex

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocIndex

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

Formats the value using the given formatter.

impl Default for DocIndex

fn default() -> Self

Returns the “default value” for a type.