Struct DocItem 

pub struct DocItem {
    pub name: String,
    pub kind: DocItemKind,
    pub path: String,
    pub description: String,
    pub is_public: bool,
}

A single documented item stored in the search index.

Fields

name: String

Simple name (e.g. HashMap)

kind: DocItemKind

Item kind

path: String

Fully-qualified path (e.g. std::collections::HashMap)

description: String

One-line description extracted from /// doc comment

is_public: bool

Whether the item is pub

Implementations

impl DocItem

pub fn new( name: &str, kind: DocItemKind, path: &str, description: &str, is_public: bool, ) -> Self

Create a new documented item.

pub fn html_path(&self) -> String

Return the relative HTML file path for this item.

E.g. std/collections/struct.HashMap.html

Trait Implementations

impl Clone for DocItem

fn clone(&self) -> DocItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocItem

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

Formats the value using the given formatter.

impl PartialEq for DocItem

fn eq(&self, other: &DocItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DocItem

impl StructuralPartialEq for DocItem