Struct rustdoc_seeker::DocItem [−][src]
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
[src]
impl DocItem
pub fn new(
name: TypeItem,
parent: Option<TypeItem>,
path: Atom,
desc: Atom
) -> DocItem
[src]
pub fn new(
name: TypeItem,
parent: Option<TypeItem>,
path: Atom,
desc: Atom
) -> DocItem
pub fn fmt_naive(&self, f: &mut Formatter) -> Result
[src]
pub fn fmt_naive(&self, f: &mut Formatter) -> Result
pub fn fmt_url(&self, f: &mut Formatter) -> Result
[src]
pub fn fmt_url(&self, f: &mut Formatter) -> Result
Trait Implementations
impl Debug for DocItem
[src]
impl Debug for DocItem
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Eq for DocItem
[src]
impl Eq for DocItem
impl PartialEq for DocItem
[src]
impl PartialEq for DocItem
fn eq(&self, other: &DocItem) -> bool
[src]
fn eq(&self, other: &DocItem) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl Ord for DocItem
[src]
impl Ord for DocItem
fn cmp(&self, other: &Self) -> Ordering
[src]
fn cmp(&self, other: &Self) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl PartialOrd for DocItem
[src]
impl PartialOrd for DocItem
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Display for DocItem
[src]
impl Display for DocItem
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Extend<DocItem> for RustDoc
[src]
impl Extend<DocItem> for RustDoc
fn extend<T: IntoIterator<Item = DocItem>>(&mut self, iter: T)
[src]
fn extend<T: IntoIterator<Item = DocItem>>(&mut self, iter: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<DocItem> for RustDoc
[src]
impl FromIterator<DocItem> for RustDoc
fn from_iter<I: IntoIterator<Item = DocItem>>(iter: I) -> Self
[src]
fn from_iter<I: IntoIterator<Item = DocItem>>(iter: I) -> Self
Creates a value from an iterator. Read more