Enum rustdoc::passes::collect_intra_doc_links::Disambiguator

enum Disambiguator {
    Primitive,
    Kind(DefKind),
    Namespace(Namespace),
}

Disambiguators for a link.

Variants

Primitive

prim@

This is buggy, see https://github.com/rust-lang/rust/pull/77875#discussion_r503583103

Kind(DefKind)

struct@ or f()

Namespace(Namespace)

type@

Implementations

impl Disambiguator

fn display_for(&self, path: &str) -> String

The text that should be displayed when the path is rendered as HTML.

NOTE: path is not the original link given by the user, but a name suitable for passing to resolve.

fn from_str(link: &str) -> Result<Option<(Self, &str)>, (String, Range<usize>)>

Given a link, parse and return (disambiguator, path_str).

This returns Ok(Some(...)) if a disambiguator was found, Ok(None) if no disambiguator was found, or Err(...) if there was a problem with the disambiguator.

fn from_res(res: Res) -> Self

fn suggestion(self) -> Suggestion

Used for error reporting.

fn ns(self) -> Namespace

fn article(self) -> &'static str

fn descr(self) -> &'static str

Trait Implementations

impl Clone for Disambiguator

fn clone(&self) -> Disambiguator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Disambiguator

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

Formats the value using the given formatter.

impl Hash for Disambiguator

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Disambiguator> for Disambiguator

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

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

fn ne(&self, other: &Disambiguator) -> bool

This method tests for !=.

impl Copy for Disambiguator

impl Eq for Disambiguator

impl StructuralEq for Disambiguator

impl StructuralPartialEq for Disambiguator