Enum rustdoc::passes::collect_intra_doc_links::ResolutionFailure

source · [−]

enum ResolutionFailure<'a> {
    WrongNamespace {
        res: Res,
        expected_ns: Namespace,
    },
    NotResolved {
        module_id: DefId,
        partial_res: Option<Res>,
        unresolved: Cow<'a, str>,
    },
    NoParentItem,
    MalformedGenerics(MalformedGenerics),
    Dummy,
}

Expand description

A link failed to resolve.

Variants

`WrongNamespace`

Fields

res: Res

What the link resolved to.

expected_ns: Namespace

The expected namespace for the resolution, determined from the link’s disambiguator.

E.g., for [fn@Result] this is Namespace::ValueNS, even though Result’s actual namespace is Namespace::TypeNS.

This resolved, but with the wrong namespace.

`NotResolved`

Fields

module_id: DefId

The scope the link was resolved in.

partial_res: Option<Res>

If part of the link resolved, this has the Res.

In [std::io::Error::x], std::io::Error would be a partial resolution.

unresolved: Cow<'a, str>

The remaining unresolved path segments.

In [std::io::Error::x], x would be unresolved.

The link failed to resolve. resolution_failure should look to see if there’s a more helpful error that can be given.

`NoParentItem`

This happens when rustdoc can’t determine the parent scope for an item. It is always a bug in rustdoc.

`MalformedGenerics(MalformedGenerics)`

This link has malformed generic parameters; e.g., the angle brackets are unbalanced.

`Dummy`

Used to communicate that this should be ignored, but shouldn’t be reported to the user.

This happens when there is no disambiguator and one of the namespaces failed to resolve.

Implementations

source

impl ResolutionFailure<'_>

source

fn full_res(&self) -> Option<Res>

This resolved fully (not just partially) but is erroneous for some other reason

Returns the full resolution of the link, if present.

Trait Implementations

source

impl<'a> Debug for ResolutionFailure<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> From<ResolutionFailure<'a>> for ErrorKind<'a>

source

fn from(err: ResolutionFailure<'a>) -> Self

Performs the conversion.

Auto Trait Implementations

impl<'a> RefUnwindSafe for ResolutionFailure<'a>

impl<'a> Send for ResolutionFailure<'a>

impl<'a> Sync for ResolutionFailure<'a>

impl<'a> Unpin for ResolutionFailure<'a>

impl<'a> UnwindSafe for ResolutionFailure<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

impl<'a, T> Captures<'a> for T where
T: ?Sized,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. 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: 56 bytes

Size for each variant:

WrongNamespace: 15 bytes
NotResolved: 55 bytes
NoParentItem: 0 bytes
MalformedGenerics: 1 byte
Dummy: 0 bytes

Enum rustdoc::passes::collect_intra_doc_links::ResolutionFailure

Variants

WrongNamespace

Fields

NotResolved

Fields

NoParentItem

MalformedGenerics(MalformedGenerics)

Dummy

Implementations

impl ResolutionFailure<'_>

fn full_res(&self) -> Option<Res>

Trait Implementations

impl<'a> Debug for ResolutionFailure<'a>

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

impl<'a> From<ResolutionFailure<'a>> for ErrorKind<'a>

fn from(err: ResolutionFailure<'a>) -> Self

Auto Trait Implementations

impl<'a> RefUnwindSafe for ResolutionFailure<'a>

impl<'a> Send for ResolutionFailure<'a>

impl<'a> Sync for ResolutionFailure<'a>

impl<'a> Unpin for ResolutionFailure<'a>

impl<'a> UnwindSafe for ResolutionFailure<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<'a, T> Captures<'a> for T where T: ?Sized,

Layout

`WrongNamespace`

`NotResolved`

`NoParentItem`

`MalformedGenerics(MalformedGenerics)`

`Dummy`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<'a, T> Captures<'a> for T where
T: ?Sized,