Skip to main content

Module types

Module types 

Source

Re-exportsΒ§

use std::fmt::Write; πŸ”’
use std::hash::Hash; πŸ”’
use std::hash::Hash; πŸ”’
use std::path::PathBuf; πŸ”’
use std::sync::Arc; πŸ”’
use std::sync::OnceLock as OnceCell; πŸ”’
use std::fmt; πŸ”’
use std::iter; πŸ”’
use arrayvec::ArrayVec; πŸ”’
use itertools::Either; πŸ”’
use rustc_abi::ExternAbi; πŸ”’
use rustc_abi::VariantIdx; πŸ”’
use rustc_ast as ast; πŸ”’
use rustc_attr_ir::lang_items::LangItem; πŸ”’
use rustc_attr_ir::AttributeKind; πŸ”’
use rustc_attr_ir::ConstStability; πŸ”’
use rustc_attr_ir::DeprecatedSince; πŸ”’
use rustc_attr_ir::Deprecation; πŸ”’
use rustc_attr_ir::DocAttribute; πŸ”’
use rustc_attr_ir::Stability; πŸ”’
use rustc_attr_ir::StableSince; πŸ”’
use rustc_attr_ir::find_attr; πŸ”’
use rustc_data_structures::fx::FxHashSet; πŸ”’
use rustc_data_structures::fx::FxIndexMap; πŸ”’
use rustc_data_structures::fx::FxIndexSet; πŸ”’
use rustc_data_structures::thin_vec::ThinVec; πŸ”’
use rustc_hir as hir; πŸ”’
use rustc_hir::def::CtorKind; πŸ”’
use rustc_hir::def::DefKind; πŸ”’
use rustc_hir::def::MacroKinds; πŸ”’
use rustc_hir::def::Res; πŸ”’
use rustc_hir::def_id::CrateNum; πŸ”’
use rustc_hir::def_id::DefId; πŸ”’
use rustc_hir::def_id::LOCAL_CRATE; πŸ”’
use rustc_hir::def_id::LocalDefId; πŸ”’
use rustc_hir::BodyId; πŸ”’
use rustc_hir::Mutability; πŸ”’
use rustc_index::IndexVec; πŸ”’
use rustc_metadata::rendered_const; πŸ”’
use rustc_middle::ty::fast_reject::SimplifiedType; πŸ”’
use rustc_middle::ty; πŸ”’
use rustc_middle::ty::Ty; πŸ”’
use rustc_middle::ty::TyCtxt; πŸ”’
use rustc_middle::ty::Visibility; πŸ”’
use rustc_resolve::rustdoc::DocFragment; πŸ”’
use rustc_resolve::rustdoc::add_doc_fragment; πŸ”’
use rustc_resolve::rustdoc::attrs_to_doc_fragments; πŸ”’
use rustc_resolve::rustdoc::span_of_fragments; πŸ”’
use rustc_session::Session; πŸ”’
use rustc_span::def_id::CRATE_DEF_ID; πŸ”’
use rustc_span::def_id::ModId; πŸ”’
use rustc_span::hygiene::MacroKind; πŸ”’
use rustc_span::symbol::Symbol; πŸ”’
use rustc_span::symbol::kw; πŸ”’
use rustc_span::symbol::sym; πŸ”’
use rustc_span::DUMMY_SP; πŸ”’
use rustc_span::FileName; πŸ”’
use rustc_span::Ident; πŸ”’
use rustc_span::Loc; πŸ”’
use rustc_span::RemapPathScopeComponents; πŸ”’
use rustc_span::span_bug; πŸ”’
use tracing::debug; πŸ”’
use tracing::trace; πŸ”’
pub(crate) use self::Type::Array; πŸ”’
pub(crate) use self::Type::BareFunction; πŸ”’
pub(crate) use self::Type::BorrowedRef; πŸ”’
pub(crate) use self::Type::DynTrait; πŸ”’
pub(crate) use self::Type::Generic; πŸ”’
pub(crate) use self::Type::ImplTrait; πŸ”’
pub(crate) use self::Type::Infer; πŸ”’
pub(crate) use self::Type::Primitive; πŸ”’
pub(crate) use self::Type::QPath; πŸ”’
pub(crate) use self::Type::RawPointer; πŸ”’
pub(crate) use self::Type::SelfTy; πŸ”’
pub(crate) use self::Type::Slice; πŸ”’
pub(crate) use self::Type::Tuple; πŸ”’
pub(crate) use self::Type::UnsafeBinder; πŸ”’
use crate::clean::cfg::Cfg; πŸ”’
use crate::clean::clean_middle_path; πŸ”’
use crate::clean::inline; πŸ”’
use crate::clean::inline::print_inlined_const; πŸ”’
use crate::clean::utils::is_literal_expr; πŸ”’
use crate::clean::utils::print_evaluated_const; πŸ”’
use crate::core::DocContext; πŸ”’
use crate::formats::cache::Cache; πŸ”’
use crate::formats::item_type::ItemType; πŸ”’
use crate::html::format::HrefInfo; πŸ”’
use crate::html::render::Context; πŸ”’
use crate::passes::collect_intra_doc_links::UrlFragment; πŸ”’

ModulesΒ§

size_asserts πŸ”’

StructsΒ§

AliasedType πŸ”’
AssocConstant πŸ”’
AssocFunction πŸ”’
AssocItemConstraint πŸ”’
A constraint on an associated item.
AssocType πŸ”’
Attributes πŸ”’
The attributes on an Item, including attributes like #[derive(...)] and #[inline], as well as doc comments.
BareFunctionDecl πŸ”’
Constant πŸ”’
Crate πŸ”’
The crate currently being documented.
DeclMacro πŸ”’
Discriminant πŸ”’
Enum πŸ”’
ExternalCrate πŸ”’
FnDecl πŸ”’
Function πŸ”’
GenericParamDef πŸ”’
Generics πŸ”’
Impl πŸ”’
Import πŸ”’
ImportSource πŸ”’
Item πŸ”’
Anything with a source location and set of attributes and, optionally, a name. That is, anything that can be documented. This doesn’t correspond directly to the AST’s concept of an item; it’s a strict superset.
ItemInner πŸ”’
ItemLink πŸ”’
A link that has not yet been rendered.
Lifetime πŸ”’
Module πŸ”’
Parameter πŸ”’
A function parameter.
Path πŸ”’
PathSegment πŸ”’
PolyTrait πŸ”’
A trait reference, which may have higher ranked lifetimes.
ProcMacro πŸ”’
QPathData πŸ”’
RenderedLink
Span πŸ”’
Small wrapper around [rustc_span::Span] that adds helper methods and enforces calling [rustc_span::Span::source_callsite()].
Static πŸ”’
Struct πŸ”’
Trait πŸ”’
TraitAlias πŸ”’
TypeAlias πŸ”’
Union πŸ”’
UnsafeBinderTy πŸ”’
Variant πŸ”’
VariantStruct πŸ”’
This is a more limited form of the standard Struct, different in that it lacks the things most items have (name, id, parameterization). Found only as a variant in an enum.

EnumsΒ§

AssocItemConstraintKind πŸ”’
The kind of associated item constraint.
ConstantExpr πŸ”’
Defaultness πŸ”’
ExternalLocation πŸ”’
Indicates where an external crate can be found.
GenericArg πŸ”’
GenericArgs πŸ”’
GenericBound πŸ”’
GenericParamDefKind πŸ”’
ImplKind πŸ”’
ImportKind πŸ”’
ItemId πŸ”’
ItemKind πŸ”’
PreciseCapturingArg πŸ”’
PrimitiveType πŸ”’
A primitive (aka, builtin) type.
Term πŸ”’
Type πŸ”’
Rustdoc’s representation of types, mostly based on the [hir::Ty].
TypeAliasInnerType πŸ”’
VariantKind πŸ”’
WherePredicate πŸ”’

FunctionsΒ§

is_field_vis_inherited πŸ”’
rustc_span πŸ”’

Type AliasesΒ§

ItemIdSet πŸ”’
SimplifiedTypes πŸ”’