Enum rustdoc::html::format::HrefError

pub(crate) enum HrefError {
    DocumentationNotBuilt,
    Private,
    NotInExternalCache,
}

Variants

DocumentationNotBuilt

This item is known to rustdoc, but from a crate that does not have documentation generated.

This can only happen for non-local items.

Example

Crate a defines a public trait and crate b – the target crate that depends on a – implements it for a local type. We document b but not a (we only build the latter – with rustc):

rustc a.rs --crate-type=lib
rustdoc b.rs --crate-type=lib --extern=a=liba.rlib

Now, the associated items in the trait impl want to link to the corresponding item in the trait declaration (see html::render::assoc_href_attr) but it’s not available since their documentation (was) not built.

Private

This can only happen for non-local items when --document-private-items is not passed.

NotInExternalCache

Trait Implementations

impl PartialEq<HrefError> for HrefError

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HrefError

impl StructuralEq for HrefError

impl StructuralPartialEq for HrefError

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: 1 byte

Size for each variant:

• DocumentationNotBuilt: 0 bytes
• Private: 0 bytes
• NotInExternalCache: 0 bytes