Enum rustdoc::passes::collect_intra_doc_links::AnchorFailure

enum AnchorFailure {
    MultipleAnchors,
    RustdocAnchorConflict(Res),
}

Variants

MultipleAnchors

User error: [std#x#y] is not valid

RustdocAnchorConflict

The anchor provided by the user conflicts with Rustdoc’s generated anchor.

This is an unfortunate state of affairs. Not every item that can be linked to has its own page; sometimes it is a subheading within a page, like for associated items. In those cases, rustdoc uses an anchor to link to the subheading. Since you can’t have two anchors for the same link, Rustdoc disallows having a user-specified anchor.

Most of the time this is fine, because you can just link to the page of the item if you want to provide your own anchor. For primitives, though, rustdoc uses the anchor as a side channel to know which page to link to; it doesn’t show up in the generated link. Ideally, rustdoc would remove this limitation, allowing you to link to subheaders on primitives.

Tuple Fields of RustdocAnchorConflict

0: Res

Trait Implementations

impl From<AnchorFailure> for PreprocessingError<'_>

fn from(err: AnchorFailure) -> Self

Performs the conversion.

Layout

Note: Most layout information is completely unstable and may be different between compiler versions and platforms. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 12 bytes