Enum rustdoc::passes::collect_intra_doc_links::MalformedGenerics

pub(in passes::collect_intra_doc_links) enum MalformedGenerics {
    UnbalancedAngleBrackets,
    MissingType,
    HasFullyQualifiedSyntax,
    InvalidPathSeparator,
    TooManyAngleBrackets,
    EmptyAngleBrackets,
}

Variants

UnbalancedAngleBrackets

This link has unbalanced angle brackets.

For example, Vec<T should trigger this, as should Vec<T>>.

MissingType

The generics are not attached to a type.

For example, <T> should trigger this.

This is detected by checking if the path is empty after the generics are stripped.

HasFullyQualifiedSyntax

The link uses fully-qualified syntax, which is currently unsupported.

For example, <Vec as IntoIterator>::into_iter should trigger this.

This is detected by checking if as (the keyword as with spaces around it) is inside angle brackets.

InvalidPathSeparator

The link has an invalid path separator.

For example, Vec:<T>:new() should trigger this. Note that Vec:new() will not trigger this because it has no generics and thus strip_generics_from_path will not be called.

Note that this will also not be triggered if the invalid path separator is inside angle brackets because rustdoc mostly ignores what's inside angle brackets (except for HasFullyQualifiedSyntax).

This is detected by checking if there is a colon followed by a non-colon in the link.

TooManyAngleBrackets

The link has too many angle brackets.

For example, Vec<<T>> should trigger this.

EmptyAngleBrackets

The link has empty angle brackets.

For example, Vec<> should trigger this.

Trait Implementations

impl Debug for MalformedGenerics

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

Formats the value using the given formatter.