Struct 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 fmt_naive<W: Write>(&self, f: &mut W) -> Result

pub fn fmt_url<W: Write>(&self, f: &mut W) -> Result

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 Ord for DocItem

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for DocItem

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DocItem