Enum rustdoc::passes::collect_intra_doc_links::Disambiguator

pub(in passes::collect_intra_doc_links) 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

pub(in passes::collect_intra_doc_links) 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.

pub(in passes::collect_intra_doc_links) fn from_str(
    link: &str
) -> Result<(Self, &str), ()>

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

pub(in passes::collect_intra_doc_links) fn from_res(
    res: Res
) -> Self

WARNING: panics on Res::Err

pub(in passes::collect_intra_doc_links) fn suggestion(
    self
) -> Suggestion

Used for error reporting.

pub(in passes::collect_intra_doc_links) fn ns(
    self
) -> Namespace

pub(in passes::collect_intra_doc_links) fn article(
    self
) -> &'static str

pub(in passes::collect_intra_doc_links) fn descr(
    self
) -> &'static str

Trait Implementations

impl Clone for Disambiguator

pub fn clone(&self) -> Disambiguator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Disambiguator

impl Debug for Disambiguator

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

Formats the value using the given formatter.

impl Eq for Disambiguator

impl PartialEq<Disambiguator> for Disambiguator

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

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

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

This method tests for !=.

impl StructuralEq for Disambiguator

impl StructuralPartialEq for Disambiguator