Struct rustdoc_seeker::DocItem

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

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: Atom

desc: Atom

Methods

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

impl Extend<DocItem> for RustDoc

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

Extends a collection with the contents of an iterator.

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.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<DocItem> for DocItem

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<DocItem> for DocItem

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for DocItem