Struct docsearch::SimplePath

pub struct SimplePath(_, _);

Path for any item within a crate (or just the crate itself) like std::vec::Vec, anyhow::Result or thiserror.

New paths are created by the FromStr trait:

"anyhow::Result".parse::<docsearch::SimplePath>().unwrap();

Implementations

impl SimplePath

pub fn into_inner(self) -> String

Get back the original string.

pub fn crate_name(&self) -> &str

Crate name part of this path.

This can be used as argument for the start_search function.

pub fn is_std(&self) -> bool

Whether this path is for the standard library.

Trait Implementations

impl AsRef<str> for SimplePath

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Display for SimplePath

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

Formats the value using the given formatter.

impl FromStr for SimplePath

type Err = ParseError

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.