Struct rustdoc_seeker::DocItem

pub struct DocItem {
    pub name: TypeItem,
    pub parent: Option<TypeItem>,
    pub path: DefaultAtom,
    pub desc: DefaultAtom,
}

DocItem represent a searchable item, Use Display to get the relative URI of the item

eg:

The dedup (name) function of the Vec(parent) struct in std::vec(path) module.

The Vec(name) struct of None(parent) in std::vec(path) module.

The vec(name) module of None(parent) in std(path) module.

Example

println!("{} is the url of {:?}", &docitem, &docitem)

Fields

name: TypeItem

parent: Option<TypeItem>

path: DefaultAtom

desc: DefaultAtom

Implementations

impl DocItem

pub fn new( name: TypeItem, parent: Option<TypeItem>, path: Atom, desc: Atom, ) -> DocItem

pub fn key(&self) -> &[u8]

Return the key of the DocItem for index

Trait Implementations

impl Debug for DocItem

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

Formats the value using the given formatter.

impl Display for DocItem

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

Formats the value using the given formatter.

impl Extend<DocItem> for RustDoc

fn extend<T: IntoIterator<Item = DocItem>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<DocItem> for RustDoc

fn from_iter<I: IntoIterator<Item = DocItem>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for DocItem

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DocItem

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for DocItem