Struct RustDoc

pub struct RustDoc { /* private fields */ }

RustDoc contains DocItems, which could be convert to RustDocSeeker.

Example

let data = fs::read_to_string("search-index.js").unwrap();
let rustdoc: RustDoc = data.parse().unwrap();

// let's combine RustDoc
rustdoc_a.extend(rustdoc_b)

Implementations

impl RustDoc

pub fn new(items: BTreeSet<DocItem>) -> RustDoc

pub fn iter(&self) -> impl Iterator<Item = &DocItem>

pub fn build(self) -> RustDocSeeker

Build an index for searching

Trait Implementations

impl Debug for RustDoc

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 FromStr for RustDoc

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoIterator for RustDoc

type IntoIter = <BTreeSet<DocItem> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

type Item = DocItem

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.