1 //! HTML formatting module
3 //! This module contains a large number of `fmt::Display` implementations for
4 //! various types in `rustdoc::clean`. These implementations all currently
5 //! assume that HTML output is desired, although it may be possible to redesign
6 //! them in the future to instead emit any format desired.
11 use std::iter::{self, once};
14 use rustc_attr::{ConstStability, StabilityLevel};
15 use rustc_data_structures::captures::Captures;
16 use rustc_data_structures::fx::FxHashSet;
18 use rustc_hir::def::DefKind;
19 use rustc_hir::def_id::DefId;
20 use rustc_metadata::creader::{CStore, LoadedMacro};
22 use rustc_middle::ty::DefIdTree;
23 use rustc_middle::ty::TyCtxt;
24 use rustc_span::symbol::kw;
25 use rustc_span::{sym, Symbol};
26 use rustc_target::spec::abi::Abi;
28 use itertools::Itertools;
31 self, types::ExternalLocation, utils::find_nearest_parent_module, ExternalCrate, ItemId,
34 use crate::formats::item_type::ItemType;
35 use crate::html::escape::Escape;
36 use crate::html::render::Context;
38 use super::url_parts_builder::estimate_item_path_byte_length;
39 use super::url_parts_builder::UrlPartsBuilder;
41 pub(crate) trait Print {
42 fn print(self, buffer: &mut Buffer);
47 F: FnOnce(&mut Buffer),
49 fn print(self, buffer: &mut Buffer) {
54 impl Print for String {
55 fn print(self, buffer: &mut Buffer) {
56 buffer.write_str(&self);
60 impl Print for &'_ str {
61 fn print(self, buffer: &mut Buffer) {
62 buffer.write_str(self);
66 #[derive(Debug, Clone)]
67 pub(crate) struct Buffer {
72 impl core::fmt::Write for Buffer {
74 fn write_str(&mut self, s: &str) -> fmt::Result {
75 self.buffer.write_str(s)
79 fn write_char(&mut self, c: char) -> fmt::Result {
80 self.buffer.write_char(c)
84 fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result {
85 self.buffer.write_fmt(args)
90 pub(crate) fn empty_from(v: &Buffer) -> Buffer {
91 Buffer { for_html: v.for_html, buffer: String::new() }
94 pub(crate) fn html() -> Buffer {
95 Buffer { for_html: true, buffer: String::new() }
98 pub(crate) fn new() -> Buffer {
99 Buffer { for_html: false, buffer: String::new() }
102 pub(crate) fn is_empty(&self) -> bool {
103 self.buffer.is_empty()
106 pub(crate) fn into_inner(self) -> String {
110 pub(crate) fn push_str(&mut self, s: &str) {
111 self.buffer.push_str(s);
114 pub(crate) fn push_buffer(&mut self, other: Buffer) {
115 self.buffer.push_str(&other.buffer);
118 // Intended for consumption by write! and writeln! (std::fmt) but without
119 // the fmt::Result return type imposed by fmt::Write (and avoiding the trait
121 pub(crate) fn write_str(&mut self, s: &str) {
122 self.buffer.push_str(s);
125 // Intended for consumption by write! and writeln! (std::fmt) but without
126 // the fmt::Result return type imposed by fmt::Write (and avoiding the trait
128 pub(crate) fn write_fmt(&mut self, v: fmt::Arguments<'_>) {
130 self.buffer.write_fmt(v).unwrap();
133 pub(crate) fn to_display<T: Print>(mut self, t: T) -> String {
138 pub(crate) fn is_for_html(&self) -> bool {
142 pub(crate) fn reserve(&mut self, additional: usize) {
143 self.buffer.reserve(additional)
146 pub(crate) fn len(&self) -> usize {
151 pub(crate) fn comma_sep<T: fmt::Display>(
152 items: impl Iterator<Item = T>,
153 space_after_comma: bool,
154 ) -> impl fmt::Display {
155 display_fn(move |f| {
156 for (i, item) in items.enumerate() {
158 write!(f, ",{}", if space_after_comma { " " } else { "" })?;
160 fmt::Display::fmt(&item, f)?;
166 pub(crate) fn print_generic_bounds<'a, 'tcx: 'a>(
167 bounds: &'a [clean::GenericBound],
168 cx: &'a Context<'tcx>,
169 ) -> impl fmt::Display + 'a + Captures<'tcx> {
170 display_fn(move |f| {
171 let mut bounds_dup = FxHashSet::default();
173 for (i, bound) in bounds.iter().filter(|b| bounds_dup.insert(b.clone())).enumerate() {
177 fmt::Display::fmt(&bound.print(cx), f)?;
183 impl clean::GenericParamDef {
184 pub(crate) fn print<'a, 'tcx: 'a>(
186 cx: &'a Context<'tcx>,
187 ) -> impl fmt::Display + 'a + Captures<'tcx> {
188 display_fn(move |f| match &self.kind {
189 clean::GenericParamDefKind::Lifetime { outlives } => {
190 write!(f, "{}", self.name)?;
192 if !outlives.is_empty() {
194 for (i, lt) in outlives.iter().enumerate() {
198 write!(f, "{}", lt.print())?;
204 clean::GenericParamDefKind::Type { bounds, default, .. } => {
205 f.write_str(self.name.as_str())?;
207 if !bounds.is_empty() {
209 write!(f, ": {:#}", print_generic_bounds(bounds, cx))?;
211 write!(f, ": {}", print_generic_bounds(bounds, cx))?;
215 if let Some(ref ty) = default {
217 write!(f, " = {:#}", ty.print(cx))?;
219 write!(f, " = {}", ty.print(cx))?;
225 clean::GenericParamDefKind::Const { ty, default, .. } => {
227 write!(f, "const {}: {:#}", self.name, ty.print(cx))?;
229 write!(f, "const {}: {}", self.name, ty.print(cx))?;
232 if let Some(default) = default {
234 write!(f, " = {:#}", default)?;
236 write!(f, " = {}", default)?;
246 impl clean::Generics {
247 pub(crate) fn print<'a, 'tcx: 'a>(
249 cx: &'a Context<'tcx>,
250 ) -> impl fmt::Display + 'a + Captures<'tcx> {
251 display_fn(move |f| {
252 let mut real_params =
253 self.params.iter().filter(|p| !p.is_synthetic_type_param()).peekable();
254 if real_params.peek().is_none() {
259 write!(f, "<{:#}>", comma_sep(real_params.map(|g| g.print(cx)), true))
261 write!(f, "<{}>", comma_sep(real_params.map(|g| g.print(cx)), true))
267 #[derive(Clone, Copy, PartialEq, Eq)]
268 pub(crate) enum Ending {
273 /// * The Generics from which to emit a where-clause.
274 /// * The number of spaces to indent each line with.
275 /// * Whether the where-clause needs to add a comma and newline after the last bound.
276 pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
277 gens: &'a clean::Generics,
278 cx: &'a Context<'tcx>,
281 ) -> impl fmt::Display + 'a + Captures<'tcx> {
284 display_fn(move |f| {
285 let mut where_predicates = gens.where_predicates.iter().filter(|pred| {
286 !matches!(pred, clean::WherePredicate::BoundPredicate { bounds, .. } if bounds.is_empty())
288 display_fn(move |f| {
292 f.write_str("<br>")?;
296 clean::WherePredicate::BoundPredicate { ty, bounds, bound_params } => {
297 let ty_cx = ty.print(cx);
298 let generic_bounds = print_generic_bounds(bounds, cx);
300 if bound_params.is_empty() {
302 write!(f, "{ty_cx:#}: {generic_bounds:#}")
304 write!(f, "{ty_cx}: {generic_bounds}")
310 "for<{:#}> {ty_cx:#}: {generic_bounds:#}",
311 comma_sep(bound_params.iter().map(|lt| lt.print()), true)
316 "for<{}> {ty_cx}: {generic_bounds}",
317 comma_sep(bound_params.iter().map(|lt| lt.print()), true)
322 clean::WherePredicate::RegionPredicate { lifetime, bounds } => {
323 let mut bounds_display = String::new();
324 for bound in bounds.iter().map(|b| b.print(cx)) {
325 write!(bounds_display, "{bound} + ")?;
327 bounds_display.truncate(bounds_display.len() - " + ".len());
328 write!(f, "{}: {bounds_display}", lifetime.print())
330 // FIXME(fmease): Render bound params.
331 clean::WherePredicate::EqPredicate { lhs, rhs, bound_params: _ } => {
333 write!(f, "{:#} == {:#}", lhs.print(cx), rhs.print(cx))
335 write!(f, "{} == {}", lhs.print(cx), rhs.print(cx))
342 if where_predicates.peek().is_none() {
346 let where_preds = comma_sep(where_predicates, false);
347 let clause = if f.alternate() {
348 if ending == Ending::Newline {
349 format!(" where{where_preds},")
351 format!(" where{where_preds}")
354 let mut br_with_padding = String::with_capacity(6 * indent + 28);
355 br_with_padding.push_str("<br>");
358 if ending == Ending::Newline { indent + 4 } else { indent + "fn where ".len() };
360 for _ in 0..padding_amout {
361 br_with_padding.push_str(" ");
363 let where_preds = where_preds.to_string().replace("<br>", &br_with_padding);
365 if ending == Ending::Newline {
366 let mut clause = " ".repeat(indent.saturating_sub(1));
367 write!(clause, "<span class=\"where fmt-newline\">where{where_preds},</span>")?;
370 // insert a <br> tag after a single space but before multiple spaces at the start
372 format!("<br><span class=\"where\">where{where_preds}</span>")
374 // put the first one on the same line as the 'where' keyword
375 let where_preds = where_preds.replacen(&br_with_padding, " ", 1);
377 let mut clause = br_with_padding;
378 clause.truncate(clause.len() - "where ".len());
380 write!(clause, "<span class=\"where\">where{where_preds}</span>")?;
385 write!(f, "{clause}")
389 impl clean::Lifetime {
390 pub(crate) fn print(&self) -> impl fmt::Display + '_ {
395 impl clean::Constant {
396 pub(crate) fn print(&self, tcx: TyCtxt<'_>) -> impl fmt::Display + '_ {
397 let expr = self.expr(tcx);
400 if f.alternate() { f.write_str(&expr) } else { write!(f, "{}", Escape(&expr)) }
406 impl clean::PolyTrait {
407 fn print<'a, 'tcx: 'a>(
409 cx: &'a Context<'tcx>,
410 ) -> impl fmt::Display + 'a + Captures<'tcx> {
411 display_fn(move |f| {
412 if !self.generic_params.is_empty() {
417 comma_sep(self.generic_params.iter().map(|g| g.print(cx)), true)
423 comma_sep(self.generic_params.iter().map(|g| g.print(cx)), true)
428 write!(f, "{:#}", self.trait_.print(cx))
430 write!(f, "{}", self.trait_.print(cx))
436 impl clean::GenericBound {
437 pub(crate) fn print<'a, 'tcx: 'a>(
439 cx: &'a Context<'tcx>,
440 ) -> impl fmt::Display + 'a + Captures<'tcx> {
441 display_fn(move |f| match self {
442 clean::GenericBound::Outlives(lt) => write!(f, "{}", lt.print()),
443 clean::GenericBound::TraitBound(ty, modifier) => {
444 let modifier_str = match modifier {
445 hir::TraitBoundModifier::None => "",
446 hir::TraitBoundModifier::Maybe => "?",
447 // ~const is experimental; do not display those bounds in rustdoc
448 hir::TraitBoundModifier::MaybeConst => "",
451 write!(f, "{}{:#}", modifier_str, ty.print(cx))
453 write!(f, "{}{}", modifier_str, ty.print(cx))
460 impl clean::GenericArgs {
461 fn print<'a, 'tcx: 'a>(
463 cx: &'a Context<'tcx>,
464 ) -> impl fmt::Display + 'a + Captures<'tcx> {
465 display_fn(move |f| {
467 clean::GenericArgs::AngleBracketed { args, bindings } => {
468 if !args.is_empty() || !bindings.is_empty() {
472 f.write_str("<")?;
474 let mut comma = false;
475 for arg in args.iter() {
481 write!(f, "{:#}", arg.print(cx))?;
483 write!(f, "{}", arg.print(cx))?;
486 for binding in bindings.iter() {
492 write!(f, "{:#}", binding.print(cx))?;
494 write!(f, "{}", binding.print(cx))?;
500 f.write_str(">")?;
504 clean::GenericArgs::Parenthesized { inputs, output } => {
506 let mut comma = false;
507 for ty in inputs.iter() {
513 write!(f, "{:#}", ty.print(cx))?;
515 write!(f, "{}", ty.print(cx))?;
519 if let Some(ref ty) = *output {
521 write!(f, " -> {:#}", ty.print(cx))?;
523 write!(f, " -> {}", ty.print(cx))?;
533 // Possible errors when computing href link source for a `DefId`
534 #[derive(PartialEq, Eq)]
535 pub(crate) enum HrefError {
536 /// This item is known to rustdoc, but from a crate that does not have documentation generated.
538 /// This can only happen for non-local items.
542 /// Crate `a` defines a public trait and crate `b` – the target crate that depends on `a` –
543 /// implements it for a local type.
544 /// We document `b` but **not** `a` (we only _build_ the latter – with `rustc`):
547 /// rustc a.rs --crate-type=lib
548 /// rustdoc b.rs --crate-type=lib --extern=a=liba.rlib
551 /// Now, the associated items in the trait impl want to link to the corresponding item in the
552 /// trait declaration (see `html::render::assoc_href_attr`) but it's not available since their
553 /// *documentation (was) not built*.
554 DocumentationNotBuilt,
555 /// This can only happen for non-local items when `--document-private-items` is not passed.
557 // Not in external cache, href link should be in same page
561 // Panics if `syms` is empty.
562 pub(crate) fn join_with_double_colon(syms: &[Symbol]) -> String {
563 let mut s = String::with_capacity(estimate_item_path_byte_length(syms.len()));
564 s.push_str(syms[0].as_str());
565 for sym in &syms[1..] {
567 s.push_str(sym.as_str());
572 /// This function is to get the external macro path because they are not in the cache used in
573 /// `href_with_root_path`.
574 fn generate_macro_def_id_path(
577 root_path: Option<&str>,
578 ) -> Result<(String, ItemType, Vec<Symbol>), HrefError> {
579 let tcx = cx.shared.tcx;
580 let crate_name = tcx.crate_name(def_id.krate);
581 let cache = cx.cache();
583 let fqp: Vec<Symbol> = tcx
588 // extern blocks (and a few others things) have an empty name.
589 match elem.data.get_opt_name() {
590 Some(s) if !s.is_empty() => Some(s),
595 let mut relative = fqp.iter().copied();
596 let cstore = CStore::from_tcx(tcx);
597 // We need this to prevent a `panic` when this function is used from intra doc links...
598 if !cstore.has_crate_data(def_id.krate) {
599 debug!("No data for crate {}", crate_name);
600 return Err(HrefError::NotInExternalCache);
602 // Check to see if it is a macro 2.0 or built-in macro.
603 // More information in <https://rust-lang.github.io/rfcs/1584-macros.html>.
604 let is_macro_2 = match cstore.load_macro_untracked(def_id, tcx.sess) {
605 LoadedMacro::MacroDef(def, _) => {
606 // If `ast_def.macro_rules` is `true`, then it's not a macro 2.0.
607 matches!(&def.kind, ast::ItemKind::MacroDef(ast_def) if !ast_def.macro_rules)
612 let mut path = if is_macro_2 {
613 once(crate_name).chain(relative).collect()
615 vec![crate_name, relative.next_back().unwrap()]
618 // The minimum we can have is the crate name followed by the macro name. If shorter, then
619 // it means that `relative` was empty, which is an error.
620 debug!("macro path cannot be empty!");
621 return Err(HrefError::NotInExternalCache);
624 if let Some(last) = path.last_mut() {
625 *last = Symbol::intern(&format!("macro.{}.html", last.as_str()));
628 let url = match cache.extern_locations[&def_id.krate] {
629 ExternalLocation::Remote(ref s) => {
630 // `ExternalLocation::Remote` always end with a `/`.
631 format!("{}{}", s, path.iter().map(|p| p.as_str()).join("/"))
633 ExternalLocation::Local => {
634 // `root_path` always end with a `/`.
637 root_path.unwrap_or(""),
639 path.iter().map(|p| p.as_str()).join("/")
642 ExternalLocation::Unknown => {
643 debug!("crate {} not in cache when linkifying macros", crate_name);
644 return Err(HrefError::NotInExternalCache);
647 Ok((url, ItemType::Macro, fqp))
650 pub(crate) fn href_with_root_path(
653 root_path: Option<&str>,
654 ) -> Result<(String, ItemType, Vec<Symbol>), HrefError> {
656 let def_kind = tcx.def_kind(did);
657 let did = match def_kind {
658 DefKind::AssocTy | DefKind::AssocFn | DefKind::AssocConst | DefKind::Variant => {
659 // documented on their parent's page
664 let cache = cx.cache();
665 let relative_to = &cx.current;
666 fn to_module_fqp(shortty: ItemType, fqp: &[Symbol]) -> &[Symbol] {
667 if shortty == ItemType::Module { fqp } else { &fqp[..fqp.len() - 1] }
671 && !cache.effective_visibilities.is_directly_public(tcx, did)
672 && !cache.document_private
673 && !cache.primitive_locations.values().any(|&id| id == did)
675 return Err(HrefError::Private);
678 let mut is_remote = false;
679 let (fqp, shortty, mut url_parts) = match cache.paths.get(&did) {
680 Some(&(ref fqp, shortty)) => (fqp, shortty, {
681 let module_fqp = to_module_fqp(shortty, fqp.as_slice());
682 debug!(?fqp, ?shortty, ?module_fqp);
683 href_relative_parts(module_fqp, relative_to).collect()
686 if let Some(&(ref fqp, shortty)) = cache.external_paths.get(&did) {
687 let module_fqp = to_module_fqp(shortty, fqp);
691 match cache.extern_locations[&did.krate] {
692 ExternalLocation::Remote(ref s) => {
694 let s = s.trim_end_matches('/');
695 let mut builder = UrlPartsBuilder::singleton(s);
696 builder.extend(module_fqp.iter().copied());
699 ExternalLocation::Local => {
700 href_relative_parts(module_fqp, relative_to).collect()
702 ExternalLocation::Unknown => return Err(HrefError::DocumentationNotBuilt),
705 } else if matches!(def_kind, DefKind::Macro(_)) {
706 return generate_macro_def_id_path(did, cx, root_path);
708 return Err(HrefError::NotInExternalCache);
713 if let Some(root_path) = root_path {
714 let root = root_path.trim_end_matches('/');
715 url_parts.push_front(root);
720 ItemType::Module => {
721 url_parts.push("index.html");
724 let prefix = shortty.as_str();
725 let last = fqp.last().unwrap();
726 url_parts.push_fmt(format_args!("{}.{}.html", prefix, last));
729 Ok((url_parts.finish(), shortty, fqp.to_vec()))
735 ) -> Result<(String, ItemType, Vec<Symbol>), HrefError> {
736 href_with_root_path(did, cx, None)
739 /// Both paths should only be modules.
740 /// This is because modules get their own directories; that is, `std::vec` and `std::vec::Vec` will
741 /// both need `../iter/trait.Iterator.html` to get at the iterator trait.
742 pub(crate) fn href_relative_parts<'fqp>(
744 relative_to_fqp: &[Symbol],
745 ) -> Box<dyn Iterator<Item = Symbol> + 'fqp> {
746 for (i, (f, r)) in fqp.iter().zip(relative_to_fqp.iter()).enumerate() {
747 // e.g. linking to std::iter from std::vec (`dissimilar_part_count` will be 1)
749 let dissimilar_part_count = relative_to_fqp.len() - i;
750 let fqp_module = &fqp[i..fqp.len()];
752 iter::repeat(sym::dotdot)
753 .take(dissimilar_part_count)
754 .chain(fqp_module.iter().copied()),
758 // e.g. linking to std::sync::atomic from std::sync
759 if relative_to_fqp.len() < fqp.len() {
760 Box::new(fqp[relative_to_fqp.len()..fqp.len()].iter().copied())
761 // e.g. linking to std::sync from std::sync::atomic
762 } else if fqp.len() < relative_to_fqp.len() {
763 let dissimilar_part_count = relative_to_fqp.len() - fqp.len();
764 Box::new(iter::repeat(sym::dotdot).take(dissimilar_part_count))
765 // linking to the same module
767 Box::new(iter::empty())
771 /// Used to render a [`clean::Path`].
772 fn resolved_path<'cx>(
773 w: &mut fmt::Formatter<'_>,
778 cx: &'cx Context<'_>,
780 let last = path.segments.last().unwrap();
783 for seg in &path.segments[..path.segments.len() - 1] {
784 write!(w, "{}::", if seg.name == kw::PathRoot { "" } else { seg.name.as_str() })?;
788 write!(w, "{}{:#}", &last.name, last.args.print(cx))?;
790 let path = if use_absolute {
791 if let Ok((_, _, fqp)) = href(did, cx) {
794 join_with_double_colon(&fqp[..fqp.len() - 1]),
795 anchor(did, *fqp.last().unwrap(), cx)
798 last.name.to_string()
801 anchor(did, last.name, cx).to_string()
803 write!(w, "{}{}", path, last.args.print(cx))?;
809 f: &mut fmt::Formatter<'_>,
810 prim: clean::PrimitiveType,
814 primitive_link_fragment(f, prim, name, "", cx)
817 fn primitive_link_fragment(
818 f: &mut fmt::Formatter<'_>,
819 prim: clean::PrimitiveType,
825 let mut needs_termination = false;
827 match m.primitive_locations.get(&prim) {
828 Some(&def_id) if def_id.is_local() => {
829 let len = cx.current.len();
830 let len = if len == 0 { 0 } else { len - 1 };
833 "<a class=\"primitive\" href=\"{}primitive.{}.html{fragment}\">",
837 needs_termination = true;
840 let loc = match m.extern_locations[&def_id.krate] {
841 ExternalLocation::Remote(ref s) => {
842 let cname_sym = ExternalCrate { crate_num: def_id.krate }.name(cx.tcx());
843 let builder: UrlPartsBuilder =
844 [s.as_str().trim_end_matches('/'), cname_sym.as_str()]
849 ExternalLocation::Local => {
850 let cname_sym = ExternalCrate { crate_num: def_id.krate }.name(cx.tcx());
851 Some(if cx.current.first() == Some(&cname_sym) {
852 iter::repeat(sym::dotdot).take(cx.current.len() - 1).collect()
854 iter::repeat(sym::dotdot)
855 .take(cx.current.len())
856 .chain(iter::once(cname_sym))
860 ExternalLocation::Unknown => None,
862 if let Some(mut loc) = loc {
863 loc.push_fmt(format_args!("primitive.{}.html", prim.as_sym()));
864 write!(f, "<a class=\"primitive\" href=\"{}{fragment}\">", loc.finish())?;
865 needs_termination = true;
871 write!(f, "{}", name)?;
872 if needs_termination {
878 /// Helper to render type parameters
879 fn tybounds<'a, 'tcx: 'a>(
880 bounds: &'a [clean::PolyTrait],
881 lt: &'a Option<clean::Lifetime>,
882 cx: &'a Context<'tcx>,
883 ) -> impl fmt::Display + 'a + Captures<'tcx> {
884 display_fn(move |f| {
885 for (i, bound) in bounds.iter().enumerate() {
890 fmt::Display::fmt(&bound.print(cx), f)?;
893 if let Some(lt) = lt {
895 fmt::Display::fmt(<.print(), f)?;
901 pub(crate) fn anchor<'a, 'cx: 'a>(
904 cx: &'cx Context<'_>,
905 ) -> impl fmt::Display + 'a {
906 let parts = href(did, cx);
907 display_fn(move |f| {
908 if let Ok((url, short_ty, fqp)) = parts {
911 r#"<a class="{}" href="{}" title="{} {}">{}</a>"#,
915 join_with_double_colon(&fqp),
919 write!(f, "{}", text)
926 f: &mut fmt::Formatter<'_>,
928 cx: &'cx Context<'_>,
930 trace!("fmt_type(t = {:?})", t);
933 clean::Generic(name) => write!(f, "{}", name),
934 clean::Type::Path { ref path } => {
935 // Paths like `T::Output` and `Self::Output` should be rendered with all segments.
936 let did = path.def_id();
937 resolved_path(f, did, path, path.is_assoc_ty(), use_absolute, cx)
939 clean::DynTrait(ref bounds, ref lt) => {
940 f.write_str("dyn ")?;
941 fmt::Display::fmt(&tybounds(bounds, lt, cx), f)
943 clean::Infer => write!(f, "_"),
944 clean::Primitive(clean::PrimitiveType::Never) => {
945 primitive_link(f, PrimitiveType::Never, "!", cx)
947 clean::Primitive(prim) => primitive_link(f, prim, prim.as_sym().as_str(), cx),
948 clean::BareFunction(ref decl) => {
953 decl.print_hrtb_with_space(cx),
954 decl.unsafety.print_with_space(),
955 print_abi_with_space(decl.abi),
962 decl.print_hrtb_with_space(cx),
963 decl.unsafety.print_with_space(),
964 print_abi_with_space(decl.abi)
966 primitive_link(f, PrimitiveType::Fn, "fn", cx)?;
967 write!(f, "{}", decl.decl.print(cx))
970 clean::Tuple(ref typs) => {
972 &[] => primitive_link(f, PrimitiveType::Unit, "()", cx),
974 if let clean::Generic(name) = one {
975 primitive_link(f, PrimitiveType::Tuple, &format!("({name},)"), cx)
978 // Carry `f.alternate()` into this display w/o branching manually.
979 fmt::Display::fmt(&one.print(cx), f)?;
984 let generic_names: Vec<Symbol> = many
986 .filter_map(|t| match t {
987 clean::Generic(name) => Some(*name),
991 let is_generic = generic_names.len() == many.len();
995 PrimitiveType::Tuple,
996 &format!("({})", generic_names.iter().map(|s| s.as_str()).join(", ")),
1001 for (i, item) in many.iter().enumerate() {
1005 // Carry `f.alternate()` into this display w/o branching manually.
1006 fmt::Display::fmt(&item.print(cx), f)?;
1013 clean::Slice(ref t) => match **t {
1014 clean::Generic(name) => {
1015 primitive_link(f, PrimitiveType::Slice, &format!("[{name}]"), cx)
1019 fmt::Display::fmt(&t.print(cx), f)?;
1023 clean::Array(ref t, ref n) => match **t {
1024 clean::Generic(name) if !f.alternate() => primitive_link(
1026 PrimitiveType::Array,
1027 &format!("[{name}; {n}]", n = Escape(n)),
1032 fmt::Display::fmt(&t.print(cx), f)?;
1034 write!(f, "; {n}")?;
1037 primitive_link(f, PrimitiveType::Array, &format!("{n}", n = Escape(n)), cx)?;
1042 clean::RawPointer(m, ref t) => {
1044 hir::Mutability::Mut => "mut",
1045 hir::Mutability::Not => "const",
1048 if matches!(**t, clean::Generic(_)) || t.is_assoc_ty() {
1049 let text = if f.alternate() {
1050 format!("*{} {:#}", m, t.print(cx))
1052 format!("*{} {}", m, t.print(cx))
1054 primitive_link(f, clean::PrimitiveType::RawPointer, &text, cx)
1056 primitive_link(f, clean::PrimitiveType::RawPointer, &format!("*{} ", m), cx)?;
1057 fmt::Display::fmt(&t.print(cx), f)
1060 clean::BorrowedRef { lifetime: ref l, mutability, type_: ref ty } => {
1062 Some(l) => format!("{} ", l.print()),
1065 let m = mutability.print_with_space();
1066 let amp = if f.alternate() { "&" } else { "&" };
1068 clean::DynTrait(ref bounds, ref trait_lt)
1069 if bounds.len() > 1 || trait_lt.is_some() =>
1071 write!(f, "{}{}{}(", amp, lt, m)?;
1072 fmt_type(ty, f, use_absolute, cx)?;
1075 clean::Generic(name) => {
1076 primitive_link(f, PrimitiveType::Reference, &format!("{amp}{lt}{m}{name}"), cx)
1079 write!(f, "{}{}{}", amp, lt, m)?;
1080 fmt_type(ty, f, use_absolute, cx)
1084 clean::ImplTrait(ref bounds) => {
1086 write!(f, "impl {:#}", print_generic_bounds(bounds, cx))
1088 write!(f, "impl {}", print_generic_bounds(bounds, cx))
1091 clean::QPath(box clean::QPathData {
1098 if should_show_cast {
1099 write!(f, "<{:#} as {:#}>::", self_type.print(cx), trait_.print(cx))?
1101 write!(f, "{:#}::", self_type.print(cx))?
1104 if should_show_cast {
1105 write!(f, "<{} as {}>::", self_type.print(cx), trait_.print(cx))?
1107 write!(f, "{}::", self_type.print(cx))?
1110 // It's pretty unsightly to look at `<A as B>::C` in output, and
1111 // we've got hyperlinking on our side, so try to avoid longer
1112 // notation as much as possible by making `C` a hyperlink to trait
1113 // `B` to disambiguate.
1115 // FIXME: this is still a lossy conversion and there should probably
1116 // be a better way of representing this in general? Most of
1117 // the ugliness comes from inlining across crates where
1118 // everything comes in as a fully resolved QPath (hard to
1120 match href(trait_.def_id(), cx) {
1121 Ok((ref url, _, ref path)) if !f.alternate() => {
1124 "<a class=\"associatedtype\" href=\"{url}#{shortty}.{name}\" \
1125 title=\"type {path}::{name}\">{name}</a>{args}",
1127 shortty = ItemType::AssocType,
1129 path = join_with_double_colon(path),
1130 args = assoc.args.print(cx),
1133 _ => write!(f, "{}{:#}", assoc.name, assoc.args.print(cx))?,
1141 pub(crate) fn print<'b, 'a: 'b, 'tcx: 'a>(
1143 cx: &'a Context<'tcx>,
1144 ) -> impl fmt::Display + 'b + Captures<'tcx> {
1145 display_fn(move |f| fmt_type(self, f, false, cx))
1150 pub(crate) fn print<'b, 'a: 'b, 'tcx: 'a>(
1152 cx: &'a Context<'tcx>,
1153 ) -> impl fmt::Display + 'b + Captures<'tcx> {
1154 display_fn(move |f| resolved_path(f, self.def_id(), self, false, false, cx))
1159 pub(crate) fn print<'a, 'tcx: 'a>(
1162 cx: &'a Context<'tcx>,
1163 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1164 display_fn(move |f| {
1166 write!(f, "impl{:#} ", self.generics.print(cx))?;
1168 write!(f, "impl{} ", self.generics.print(cx))?;
1171 if let Some(ref ty) = self.trait_ {
1172 match self.polarity {
1173 ty::ImplPolarity::Positive | ty::ImplPolarity::Reservation => {}
1174 ty::ImplPolarity::Negative => write!(f, "!")?,
1176 fmt::Display::fmt(&ty.print(cx), f)?;
1177 write!(f, " for ")?;
1180 if let clean::Type::Tuple(types) = &self.for_ &&
1181 let [clean::Type::Generic(name)] = &types[..] &&
1182 (self.kind.is_fake_variadic() || self.kind.is_auto())
1184 // Hardcoded anchor library/core/src/primitive_docs.rs
1185 // Link should match `# Trait implementations`
1186 primitive_link_fragment(f, PrimitiveType::Tuple, &format!("({name}₁, {name}₂, …, {name}ₙ)"), "#trait-implementations-1", cx)?;
1187 } else if let clean::BareFunction(bare_fn) = &self.for_ &&
1188 let [clean::Argument { type_: clean::Type::Generic(name), .. }] = &bare_fn.decl.inputs.values[..] &&
1189 (self.kind.is_fake_variadic() || self.kind.is_auto())
1191 // Hardcoded anchor library/core/src/primitive_docs.rs
1192 // Link should match `# Trait implementations`
1194 let hrtb = bare_fn.print_hrtb_with_space(cx);
1195 let unsafety = bare_fn.unsafety.print_with_space();
1196 let abi = print_abi_with_space(bare_fn.abi);
1200 "{hrtb:#}{unsafety}{abi:#}",
1205 "{hrtb}{unsafety}{abi}",
1208 let ellipsis = if bare_fn.decl.c_variadic {
1213 primitive_link_fragment(f, PrimitiveType::Tuple, &format!("fn ({name}₁, {name}₂, …, {name}ₙ{ellipsis})"), "#trait-implementations-1", cx)?;
1215 if let clean::FnRetTy::Return(ty) = &bare_fn.decl.output {
1217 fmt_type(ty, f, use_absolute, cx)?;
1219 } else if let Some(ty) = self.kind.as_blanket_ty() {
1220 fmt_type(ty, f, use_absolute, cx)?;
1222 fmt_type(&self.for_, f, use_absolute, cx)?;
1225 fmt::Display::fmt(&print_where_clause(&self.generics, cx, 0, Ending::Newline), f)?;
1231 impl clean::Arguments {
1232 pub(crate) fn print<'a, 'tcx: 'a>(
1234 cx: &'a Context<'tcx>,
1235 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1236 display_fn(move |f| {
1237 for (i, input) in self.values.iter().enumerate() {
1238 write!(f, "{}: ", input.name)?;
1241 write!(f, "{:#}", input.type_.print(cx))?;
1243 write!(f, "{}", input.type_.print(cx))?;
1245 if i + 1 < self.values.len() {
1254 impl clean::FnRetTy {
1255 pub(crate) fn print<'a, 'tcx: 'a>(
1257 cx: &'a Context<'tcx>,
1258 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1259 display_fn(move |f| match self {
1260 clean::Return(clean::Tuple(tys)) if tys.is_empty() => Ok(()),
1261 clean::Return(ty) if f.alternate() => {
1262 write!(f, " -> {:#}", ty.print(cx))
1264 clean::Return(ty) => write!(f, " -> {}", ty.print(cx)),
1265 clean::DefaultReturn => Ok(()),
1270 impl clean::BareFunctionDecl {
1271 fn print_hrtb_with_space<'a, 'tcx: 'a>(
1273 cx: &'a Context<'tcx>,
1274 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1275 display_fn(move |f| {
1276 if !self.generic_params.is_empty() {
1280 comma_sep(self.generic_params.iter().map(|g| g.print(cx)), true)
1289 impl clean::FnDecl {
1290 pub(crate) fn print<'b, 'a: 'b, 'tcx: 'a>(
1292 cx: &'a Context<'tcx>,
1293 ) -> impl fmt::Display + 'b + Captures<'tcx> {
1294 display_fn(move |f| {
1295 let ellipsis = if self.c_variadic { ", ..." } else { "" };
1299 "({args:#}{ellipsis}){arrow:#}",
1300 args = self.inputs.print(cx),
1301 ellipsis = ellipsis,
1302 arrow = self.output.print(cx)
1307 "({args}{ellipsis}){arrow}",
1308 args = self.inputs.print(cx),
1309 ellipsis = ellipsis,
1310 arrow = self.output.print(cx)
1316 /// * `header_len`: The length of the function header and name. In other words, the number of
1317 /// characters in the function declaration up to but not including the parentheses.
1318 /// <br>Used to determine line-wrapping.
1319 /// * `indent`: The number of spaces to indent each successive line with, if line-wrapping is
1321 pub(crate) fn full_print<'a, 'tcx: 'a>(
1325 cx: &'a Context<'tcx>,
1326 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1327 display_fn(move |f| self.inner_full_print(header_len, indent, f, cx))
1330 fn inner_full_print(
1334 f: &mut fmt::Formatter<'_>,
1337 let amp = if f.alternate() { "&" } else { "&" };
1338 let mut args = Buffer::html();
1339 let mut args_plain = Buffer::new();
1340 for (i, input) in self.inputs.values.iter().enumerate() {
1341 if let Some(selfty) = input.to_self() {
1343 clean::SelfValue => {
1344 args.push_str("self");
1345 args_plain.push_str("self");
1347 clean::SelfBorrowed(Some(ref lt), mtbl) => {
1348 write!(args, "{}{} {}self", amp, lt.print(), mtbl.print_with_space());
1349 write!(args_plain, "&{} {}self", lt.print(), mtbl.print_with_space());
1351 clean::SelfBorrowed(None, mtbl) => {
1352 write!(args, "{}{}self", amp, mtbl.print_with_space());
1353 write!(args_plain, "&{}self", mtbl.print_with_space());
1355 clean::SelfExplicit(ref typ) => {
1357 write!(args, "self: {:#}", typ.print(cx));
1359 write!(args, "self: {}", typ.print(cx));
1361 write!(args_plain, "self: {:#}", typ.print(cx));
1366 args.push_str("<br>");
1369 args.push_str("const ");
1370 args_plain.push_str("const ");
1372 write!(args, "{}: ", input.name);
1373 write!(args_plain, "{}: ", input.name);
1376 write!(args, "{:#}", input.type_.print(cx));
1378 write!(args, "{}", input.type_.print(cx));
1380 write!(args_plain, "{:#}", input.type_.print(cx));
1382 if i + 1 < self.inputs.values.len() {
1384 args_plain.push_str(",");
1388 let mut args_plain = format!("({})", args_plain.into_inner());
1389 let mut args = args.into_inner();
1391 if self.c_variadic {
1392 args.push_str(",<br> ...");
1393 args_plain.push_str(", ...");
1396 let arrow_plain = format!("{:#}", self.output.print(cx));
1398 if f.alternate() { arrow_plain.clone() } else { format!("{}", self.output.print(cx)) };
1400 let declaration_len = header_len + args_plain.len() + arrow_plain.len();
1401 let output = if declaration_len > 80 {
1402 let full_pad = format!("<br>{}", " ".repeat(indent + 4));
1403 let close_pad = format!("<br>{}", " ".repeat(indent));
1405 "({pad}{args}{close}){arrow}",
1406 pad = if self.inputs.values.is_empty() { "" } else { &full_pad },
1407 args = args.replace("<br>", &full_pad),
1412 format!("({args}){arrow}", args = args.replace("<br>", " "), arrow = arrow)
1416 write!(f, "{}", output.replace("<br>", "\n"))
1418 write!(f, "{}", output)
1423 pub(crate) fn visibility_print_with_space<'a, 'tcx: 'a>(
1424 visibility: Option<ty::Visibility<DefId>>,
1426 cx: &'a Context<'tcx>,
1427 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1428 use std::fmt::Write as _;
1430 let to_print: Cow<'static, str> = match visibility {
1432 Some(ty::Visibility::Public) => "pub ".into(),
1433 Some(ty::Visibility::Restricted(vis_did)) => {
1434 // FIXME(camelid): This may not work correctly if `item_did` is a module.
1435 // However, rustdoc currently never displays a module's
1436 // visibility, so it shouldn't matter.
1437 let parent_module = find_nearest_parent_module(cx.tcx(), item_did.expect_def_id());
1439 if vis_did.is_crate_root() {
1440 "pub(crate) ".into()
1441 } else if parent_module == Some(vis_did) {
1442 // `pub(in foo)` where `foo` is the parent module
1443 // is the same as no visibility modifier
1445 } else if parent_module.and_then(|parent| find_nearest_parent_module(cx.tcx(), parent))
1448 "pub(super) ".into()
1450 let path = cx.tcx().def_path(vis_did);
1451 debug!("path={:?}", path);
1452 // modified from `resolved_path()` to work with `DefPathData`
1453 let last_name = path.data.last().unwrap().data.get_opt_name().unwrap();
1454 let anchor = anchor(vis_did, last_name, cx).to_string();
1456 let mut s = "pub(in ".to_owned();
1457 for seg in &path.data[..path.data.len() - 1] {
1458 let _ = write!(s, "{}::", seg.data.get_opt_name().unwrap());
1460 let _ = write!(s, "{}) ", anchor);
1465 display_fn(move |f| write!(f, "{}", to_print))
1468 /// This function is the same as print_with_space, except that it renders no links.
1469 /// It's used for macros' rendered source view, which is syntax highlighted and cannot have
1471 pub(crate) fn visibility_to_src_with_space<'a, 'tcx: 'a>(
1472 visibility: Option<ty::Visibility<DefId>>,
1475 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1476 let to_print = match visibility {
1477 None => String::new(),
1478 Some(ty::Visibility::Public) => "pub ".to_owned(),
1479 Some(ty::Visibility::Restricted(vis_did)) => {
1480 // FIXME(camelid): This may not work correctly if `item_did` is a module.
1481 // However, rustdoc currently never displays a module's
1482 // visibility, so it shouldn't matter.
1483 let parent_module = find_nearest_parent_module(tcx, item_did);
1485 if vis_did.is_crate_root() {
1486 "pub(crate) ".to_owned()
1487 } else if parent_module == Some(vis_did) {
1488 // `pub(in foo)` where `foo` is the parent module
1489 // is the same as no visibility modifier
1491 } else if parent_module.and_then(|parent| find_nearest_parent_module(tcx, parent))
1494 "pub(super) ".to_owned()
1496 format!("pub(in {}) ", tcx.def_path_str(vis_did))
1500 display_fn(move |f| f.write_str(&to_print))
1503 pub(crate) trait PrintWithSpace {
1504 fn print_with_space(&self) -> &str;
1507 impl PrintWithSpace for hir::Unsafety {
1508 fn print_with_space(&self) -> &str {
1510 hir::Unsafety::Unsafe => "unsafe ",
1511 hir::Unsafety::Normal => "",
1516 impl PrintWithSpace for hir::IsAsync {
1517 fn print_with_space(&self) -> &str {
1519 hir::IsAsync::Async => "async ",
1520 hir::IsAsync::NotAsync => "",
1525 impl PrintWithSpace for hir::Mutability {
1526 fn print_with_space(&self) -> &str {
1528 hir::Mutability::Not => "",
1529 hir::Mutability::Mut => "mut ",
1534 pub(crate) fn print_constness_with_space(
1536 s: Option<ConstStability>,
1539 // const stable or when feature(staged_api) is not set
1541 hir::Constness::Const,
1542 Some(ConstStability { level: StabilityLevel::Stable { .. }, .. }),
1544 | (hir::Constness::Const, None) => "const ",
1545 // const unstable or not const
1550 impl clean::Import {
1551 pub(crate) fn print<'a, 'tcx: 'a>(
1553 cx: &'a Context<'tcx>,
1554 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1555 display_fn(move |f| match self.kind {
1556 clean::ImportKind::Simple(name) => {
1557 if name == self.source.path.last() {
1558 write!(f, "use {};", self.source.print(cx))
1560 write!(f, "use {} as {};", self.source.print(cx), name)
1563 clean::ImportKind::Glob => {
1564 if self.source.path.segments.is_empty() {
1567 write!(f, "use {}::*;", self.source.print(cx))
1574 impl clean::ImportSource {
1575 pub(crate) fn print<'a, 'tcx: 'a>(
1577 cx: &'a Context<'tcx>,
1578 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1579 display_fn(move |f| match self.did {
1580 Some(did) => resolved_path(f, did, &self.path, true, false, cx),
1582 for seg in &self.path.segments[..self.path.segments.len() - 1] {
1583 write!(f, "{}::", seg.name)?;
1585 let name = self.path.last();
1586 if let hir::def::Res::PrimTy(p) = self.path.res {
1587 primitive_link(f, PrimitiveType::from(p), name.as_str(), cx)?;
1589 write!(f, "{}", name)?;
1597 impl clean::TypeBinding {
1598 pub(crate) fn print<'a, 'tcx: 'a>(
1600 cx: &'a Context<'tcx>,
1601 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1602 display_fn(move |f| {
1603 f.write_str(self.assoc.name.as_str())?;
1605 write!(f, "{:#}", self.assoc.args.print(cx))?;
1607 write!(f, "{}", self.assoc.args.print(cx))?;
1610 clean::TypeBindingKind::Equality { ref term } => {
1612 write!(f, " = {:#}", term.print(cx))?;
1614 write!(f, " = {}", term.print(cx))?;
1617 clean::TypeBindingKind::Constraint { ref bounds } => {
1618 if !bounds.is_empty() {
1620 write!(f, ": {:#}", print_generic_bounds(bounds, cx))?;
1622 write!(f, ": {}", print_generic_bounds(bounds, cx))?;
1632 pub(crate) fn print_abi_with_space(abi: Abi) -> impl fmt::Display {
1633 display_fn(move |f| {
1634 let quot = if f.alternate() { "\"" } else { """ };
1636 Abi::Rust => Ok(()),
1637 abi => write!(f, "extern {0}{1}{0} ", quot, abi.name()),
1642 pub(crate) fn print_default_space<'a>(v: bool) -> &'a str {
1643 if v { "default " } else { "" }
1646 impl clean::GenericArg {
1647 pub(crate) fn print<'a, 'tcx: 'a>(
1649 cx: &'a Context<'tcx>,
1650 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1651 display_fn(move |f| match self {
1652 clean::GenericArg::Lifetime(lt) => fmt::Display::fmt(<.print(), f),
1653 clean::GenericArg::Type(ty) => fmt::Display::fmt(&ty.print(cx), f),
1654 clean::GenericArg::Const(ct) => fmt::Display::fmt(&ct.print(cx.tcx()), f),
1655 clean::GenericArg::Infer => fmt::Display::fmt("_", f),
1660 impl clean::types::Term {
1661 pub(crate) fn print<'a, 'tcx: 'a>(
1663 cx: &'a Context<'tcx>,
1664 ) -> impl fmt::Display + 'a + Captures<'tcx> {
1665 display_fn(move |f| match self {
1666 clean::types::Term::Type(ty) => fmt::Display::fmt(&ty.print(cx), f),
1667 clean::types::Term::Constant(ct) => fmt::Display::fmt(&ct.print(cx.tcx()), f),
1672 pub(crate) fn display_fn(
1673 f: impl FnOnce(&mut fmt::Formatter<'_>) -> fmt::Result,
1674 ) -> impl fmt::Display {
1675 struct WithFormatter<F>(Cell<Option<F>>);
1677 impl<F> fmt::Display for WithFormatter<F>
1679 F: FnOnce(&mut fmt::Formatter<'_>) -> fmt::Result,
1681 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1682 (self.0.take()).unwrap()(f)
1686 WithFormatter(Cell::new(Some(f)))