1 // ignore-tidy-filelength
3 //! Rustdoc's HTML rendering module.
5 //! This modules contains the bulk of the logic necessary for rendering a
6 //! rustdoc `clean::Crate` instance to a set of static HTML pages. This
7 //! rendering process is largely driven by the `format!` syntax extension to
8 //! perform all I/O into files and streams.
10 //! The rendering process is largely driven by the `Context` and `Cache`
11 //! structures. The cache is pre-populated by crawling the crate in question,
12 //! and then it is shared among the various rendering threads. The cache is meant
13 //! to be a fairly large structure not implementing `Clone` (because it's shared
14 //! among threads). The context, however, should be a lightweight structure. This
15 //! is cloned per-thread and contains information about what is currently being
18 //! In order to speed up rendering (mostly because of markdown rendering), the
19 //! rendering process has been parallelized. This parallelization is only
20 //! exposed through the `crate` method on the context, and then also from the
21 //! fact that the shared cache is stored in TLS (and must be accessed as such).
23 //! In addition to rendering the crate itself, this module is also responsible
24 //! for creating the corresponding search index and source file renderings.
25 //! These threads are not parallelized (they haven't been a bottleneck yet), and
26 //! both occur before the crate is rendered.
29 use std::cell::{Cell, RefCell};
30 use std::cmp::Ordering;
31 use std::collections::{BTreeMap, VecDeque};
32 use std::default::Default;
36 use std::fmt::{self, Formatter, Write};
37 use std::fs::{self, File};
38 use std::io::prelude::*;
39 use std::io::{self, BufReader};
40 use std::path::{Component, Path, PathBuf};
45 use rustc::middle::privacy::AccessLevels;
46 use rustc::middle::stability;
48 use rustc_ast_pretty::pprust;
49 use rustc_data_structures::flock;
50 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
51 use rustc_feature::UnstableFeatures;
53 use rustc_hir::def_id::DefId;
54 use rustc_hir::Mutability;
55 use rustc_span::edition::Edition;
56 use rustc_span::hygiene::MacroKind;
57 use rustc_span::source_map::FileName;
58 use rustc_span::symbol::{sym, Symbol};
59 use serde::ser::SerializeSeq;
60 use serde::{Serialize, Serializer};
62 use crate::clean::{self, AttributesExt, Deprecation, GetDefId, SelfTy};
63 use crate::config::{OutputFormat, RenderOptions};
64 use crate::docfs::{DocFS, ErrorStorage, PathError};
66 use crate::html::escape::Escape;
67 use crate::html::format::fmt_impl_for_trait_page;
68 use crate::html::format::Function;
69 use crate::html::format::{href, print_default_space, print_generic_bounds, WhereClause};
70 use crate::html::format::{print_abi_with_space, Buffer, PrintWithSpace};
71 use crate::html::item_type::ItemType;
72 use crate::html::markdown::{self, ErrorCodes, IdMap, Markdown, MarkdownHtml, MarkdownSummaryLine};
73 use crate::html::sources;
74 use crate::html::{highlight, layout, static_files};
82 crate use cache::ExternalLocation::{self, *};
84 /// A pair of name and its optional document.
85 pub type NameDoc = (String, Option<String>);
87 crate fn ensure_trailing_slash(v: &str) -> impl fmt::Display + '_ {
88 crate::html::format::display_fn(move |f| {
89 if !v.ends_with('/') && !v.is_empty() { write!(f, "{}/", v) } else { write!(f, "{}", v) }
99 impl error::Error for Error {}
101 impl std::fmt::Display for Error {
102 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
103 let file = self.file.display().to_string();
105 write!(f, "{}", self.error)
107 write!(f, "\"{}\": {}", self.file.display(), self.error)
112 impl PathError for Error {
113 fn new<P: AsRef<Path>>(e: io::Error, path: P) -> Error {
114 Error { file: path.as_ref().to_path_buf(), error: e }
118 macro_rules! try_none {
119 ($e:expr, $file:expr) => {{
124 return Err(Error::new(io::Error::new(io::ErrorKind::Other, "not found"), $file));
130 macro_rules! try_err {
131 ($e:expr, $file:expr) => {{
134 Err(e) => return Err(Error::new(e, $file)),
139 /// Major driving force in all rustdoc rendering. This contains information
140 /// about where in the tree-like hierarchy rendering is occurring and controls
141 /// how the current page is being rendered.
143 /// It is intended that this context is a lightweight object which can be fairly
144 /// easily cloned because it is cloned per work-job (about once per item in the
148 /// Current hierarchy of components leading down to what's currently being
150 pub current: Vec<String>,
151 /// The current destination folder of where HTML artifacts should be placed.
152 /// This changes as the context descends into the module hierarchy.
154 /// A flag, which when `true`, will render pages which redirect to the
155 /// real location of an item. This is used to allow external links to
156 /// publicly reused items to redirect to the right location.
157 pub render_redirect_pages: bool,
158 /// The map used to ensure all generated 'id=' attributes are unique.
159 id_map: Rc<RefCell<IdMap>>,
160 pub shared: Arc<SharedContext>,
161 pub cache: Arc<Cache>,
164 crate struct SharedContext {
165 /// The path to the crate root source minus the file name.
166 /// Used for simplifying paths to the highlighted source code files.
167 pub src_root: PathBuf,
168 /// This describes the layout of each page, and is not modified after
169 /// creation of the context (contains info like the favicon and added html).
170 pub layout: layout::Layout,
171 /// This flag indicates whether `[src]` links should be generated or not. If
172 /// the source files are present in the html rendering, then this will be
174 pub include_sources: bool,
175 /// The local file sources we've emitted and their respective url-paths.
176 pub local_sources: FxHashMap<PathBuf, String>,
177 /// Whether the collapsed pass ran
179 /// The base-URL of the issue tracker for when an item has been tagged with
181 pub issue_tracker_base_url: Option<String>,
182 /// The directories that have already been created in this doc run. Used to reduce the number
183 /// of spurious `create_dir_all` calls.
184 pub created_dirs: RefCell<FxHashSet<PathBuf>>,
185 /// This flag indicates whether listings of modules (in the side bar and documentation itself)
186 /// should be ordered alphabetically or in order of appearance (in the source code).
187 pub sort_modules_alphabetically: bool,
188 /// Additional themes to be added to the generated docs.
189 pub themes: Vec<PathBuf>,
190 /// Suffix to be added on resource files (if suffix is "-v2" then "light.css" becomes
192 pub resource_suffix: String,
193 /// Optional path string to be used to load static files on output pages. If not set, uses
194 /// combinations of `../` to reach the documentation root.
195 pub static_root_path: Option<String>,
196 /// Option disabled by default to generate files used by RLS and some other tools.
197 pub generate_redirect_pages: bool,
198 /// The fs handle we are working with.
200 /// The default edition used to parse doctests.
201 pub edition: Edition,
202 pub codes: ErrorCodes,
203 playground: Option<markdown::Playground>,
207 fn path(&self, filename: &str) -> PathBuf {
208 // We use splitn vs Path::extension here because we might get a filename
209 // like `style.min.css` and we want to process that into
210 // `style-suffix.min.css`. Path::extension would just return `css`
211 // which would result in `style.min-suffix.css` which isn't what we
213 let mut iter = filename.splitn(2, '.');
214 let base = iter.next().unwrap();
215 let ext = iter.next().unwrap();
216 let filename = format!("{}{}.{}", base, self.shared.resource_suffix, ext,);
217 self.dst.join(&filename)
222 crate fn ensure_dir(&self, dst: &Path) -> Result<(), Error> {
223 let mut dirs = self.created_dirs.borrow_mut();
224 if !dirs.contains(dst) {
225 try_err!(self.fs.create_dir_all(dst), dst);
226 dirs.insert(dst.to_path_buf());
232 /// Based on whether the `collapse-docs` pass was run, return either the `doc_value` or the
233 /// `collapsed_doc_value` of the given item.
234 pub fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<Cow<'a, str>> {
236 item.collapsed_doc_value().map(|s| s.into())
238 item.doc_value().map(|s| s.into())
243 /// Metadata about implementations for a type or trait.
244 #[derive(Clone, Debug)]
246 pub impl_item: clean::Item,
250 fn inner_impl(&self) -> &clean::Impl {
251 match self.impl_item.inner {
252 clean::ImplItem(ref impl_) => impl_,
253 _ => panic!("non-impl item found in impl"),
257 fn trait_did(&self) -> Option<DefId> {
258 self.inner_impl().trait_.def_id()
262 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
263 /// Later on moved into `CACHE_KEY`.
265 pub struct RenderInfo {
266 pub inlined: FxHashSet<DefId>,
267 pub external_paths: crate::core::ExternalPaths,
268 pub exact_paths: FxHashMap<DefId, Vec<String>>,
269 pub access_levels: AccessLevels<DefId>,
270 pub deref_trait_did: Option<DefId>,
271 pub deref_mut_trait_did: Option<DefId>,
272 pub owned_box_did: Option<DefId>,
273 pub output_format: Option<OutputFormat>,
276 // Helper structs for rendering items/sidebars and carrying along contextual
279 /// Struct representing one entry in the JS search index. These are all emitted
280 /// by hand to a large JS file at the end of cache-creation.
287 parent: Option<DefId>,
288 parent_idx: Option<usize>,
289 search_type: Option<IndexItemFunctionType>,
292 impl Serialize for IndexItem {
293 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
297 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
299 (self.ty, &self.name, &self.path, &self.desc, self.parent_idx, &self.search_type)
300 .serialize(serializer)
304 /// A type used for the search index.
307 name: Option<String>,
308 generics: Option<Vec<String>>,
311 impl Serialize for Type {
312 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
316 if let Some(name) = &self.name {
317 let mut seq = serializer.serialize_seq(None)?;
318 seq.serialize_element(&name)?;
319 if let Some(generics) = &self.generics {
320 seq.serialize_element(&generics)?;
324 serializer.serialize_none()
329 /// Full type of functions/methods in the search index.
331 struct IndexItemFunctionType {
333 output: Option<Vec<Type>>,
336 impl Serialize for IndexItemFunctionType {
337 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
341 // If we couldn't figure out a type, just write `null`.
342 let mut iter = self.inputs.iter();
343 if match self.output {
344 Some(ref output) => iter.chain(output.iter()).any(|ref i| i.name.is_none()),
345 None => iter.any(|ref i| i.name.is_none()),
347 serializer.serialize_none()
349 let mut seq = serializer.serialize_seq(None)?;
350 seq.serialize_element(&self.inputs)?;
351 if let Some(output) = &self.output {
352 if output.len() > 1 {
353 seq.serialize_element(&output)?;
355 seq.serialize_element(&output[0])?;
363 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
364 thread_local!(pub static CURRENT_DEPTH: Cell<usize> = Cell::new(0));
366 pub fn initial_ids() -> Vec<String> {
378 "synthetic-implementors",
380 "synthetic-implementors-list",
386 .map(|id| (String::from(*id)))
390 /// Generates the documentation for `crate` into the directory `dst`
392 mut krate: clean::Crate,
393 options: RenderOptions,
394 renderinfo: RenderInfo,
395 diag: &rustc_errors::Handler,
397 ) -> Result<(), Error> {
398 // need to save a copy of the options for rendering the index page
399 let md_opts = options.clone();
405 sort_modules_alphabetically,
408 extern_html_root_urls,
411 generate_search_filter,
412 generate_redirect_pages,
416 let src_root = match krate.src {
417 FileName::Real(ref p) => match p.parent() {
418 Some(p) => p.to_path_buf(),
419 None => PathBuf::new(),
423 let mut errors = Arc::new(ErrorStorage::new());
424 // If user passed in `--playground-url` arg, we fill in crate name here
425 let mut playground = None;
426 if let Some(url) = playground_url {
427 playground = Some(markdown::Playground { crate_name: Some(krate.name.clone()), url });
429 let mut layout = layout::Layout {
431 favicon: String::new(),
433 krate: krate.name.clone(),
434 css_file_extension: extension_css,
435 generate_search_filter,
437 let mut issue_tracker_base_url = None;
438 let mut include_sources = true;
440 // Crawl the crate attributes looking for attributes which control how we're
441 // going to emit HTML
442 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
443 for attr in attrs.lists(sym::doc) {
444 match (attr.name_or_empty(), attr.value_str()) {
445 (sym::html_favicon_url, Some(s)) => {
446 layout.favicon = s.to_string();
448 (sym::html_logo_url, Some(s)) => {
449 layout.logo = s.to_string();
451 (sym::html_playground_url, Some(s)) => {
452 playground = Some(markdown::Playground {
453 crate_name: Some(krate.name.clone()),
457 (sym::issue_tracker_base_url, Some(s)) => {
458 issue_tracker_base_url = Some(s.to_string());
460 (sym::html_no_source, None) if attr.is_word() => {
461 include_sources = false;
467 let mut scx = SharedContext {
468 collapsed: krate.collapsed,
471 local_sources: Default::default(),
472 issue_tracker_base_url,
474 created_dirs: Default::default(),
475 sort_modules_alphabetically,
479 generate_redirect_pages,
480 fs: DocFS::new(&errors),
482 codes: ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build()),
487 scx.ensure_dir(&dst)?;
488 krate = sources::render(&dst, &mut scx, krate)?;
489 let (new_crate, index, cache) =
490 Cache::from_krate(renderinfo, &extern_html_root_urls, &dst, krate);
492 let cache = Arc::new(cache);
493 let mut cx = Context {
496 render_redirect_pages: false,
497 id_map: Rc::new(RefCell::new(id_map)),
498 shared: Arc::new(scx),
499 cache: cache.clone(),
502 // Freeze the cache now that the index has been built. Put an Arc into TLS
503 // for future parallelization opportunities
504 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
505 CURRENT_DEPTH.with(|s| s.set(0));
507 // Write shared runs within a flock; disable thread dispatching of IO temporarily.
508 Arc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(true);
509 write_shared(&cx, &krate, index, &md_opts, diag)?;
510 Arc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(false);
512 // And finally render the whole crate's documentation
513 let ret = cx.krate(krate);
514 let nb_errors = Arc::get_mut(&mut errors).map_or_else(|| 0, |errors| errors.write_errors(diag));
517 } else if nb_errors > 0 {
518 Err(Error::new(io::Error::new(io::ErrorKind::Other, "I/O error"), ""))
526 krate: &clean::Crate,
527 search_index: String,
528 options: &RenderOptions,
529 diag: &rustc_errors::Handler,
530 ) -> Result<(), Error> {
531 // Write out the shared files. Note that these are shared among all rustdoc
532 // docs placed in the output directory, so this needs to be a synchronized
533 // operation with respect to all other rustdocs running around.
534 let lock_file = cx.dst.join(".lock");
535 let _lock = try_err!(flock::Lock::new(&lock_file, true, true, true), &lock_file);
537 // Add all the static files. These may already exist, but we just
538 // overwrite them anyway to make sure that they're fresh and up-to-date.
542 cx.path("rustdoc.css"),
543 static_files::RUSTDOC_CSS,
544 options.enable_minification,
548 cx.path("settings.css"),
549 static_files::SETTINGS_CSS,
550 options.enable_minification,
554 cx.path("noscript.css"),
555 static_files::NOSCRIPT_CSS,
556 options.enable_minification,
559 // To avoid "light.css" to be overwritten, we'll first run over the received themes and only
560 // then we'll run over the "official" styles.
561 let mut themes: FxHashSet<String> = FxHashSet::default();
563 for entry in &cx.shared.themes {
564 let content = try_err!(fs::read(&entry), &entry);
565 let theme = try_none!(try_none!(entry.file_stem(), &entry).to_str(), &entry);
566 let extension = try_none!(try_none!(entry.extension(), &entry).to_str(), &entry);
567 cx.shared.fs.write(cx.path(&format!("{}.{}", theme, extension)), content.as_slice())?;
568 themes.insert(theme.to_owned());
571 let write = |p, c| cx.shared.fs.write(p, c);
572 if (*cx.shared).layout.logo.is_empty() {
573 write(cx.path("rust-logo.png"), static_files::RUST_LOGO)?;
575 if (*cx.shared).layout.favicon.is_empty() {
576 write(cx.path("favicon.ico"), static_files::RUST_FAVICON)?;
578 write(cx.path("brush.svg"), static_files::BRUSH_SVG)?;
579 write(cx.path("wheel.svg"), static_files::WHEEL_SVG)?;
580 write(cx.path("down-arrow.svg"), static_files::DOWN_ARROW_SVG)?;
583 cx.path("light.css"),
584 static_files::themes::LIGHT,
585 options.enable_minification,
587 themes.insert("light".to_owned());
591 static_files::themes::DARK,
592 options.enable_minification,
594 themes.insert("dark".to_owned());
596 let mut themes: Vec<&String> = themes.iter().collect();
598 // To avoid theme switch latencies as much as possible, we put everything theme related
599 // at the beginning of the html files into another js file.
600 let theme_js = format!(
601 r#"var themes = document.getElementById("theme-choices");
602 var themePicker = document.getElementById("theme-picker");
604 function showThemeButtonState() {{
605 themes.style.display = "block";
606 themePicker.style.borderBottomRightRadius = "0";
607 themePicker.style.borderBottomLeftRadius = "0";
610 function hideThemeButtonState() {{
611 themes.style.display = "none";
612 themePicker.style.borderBottomRightRadius = "3px";
613 themePicker.style.borderBottomLeftRadius = "3px";
616 function switchThemeButtonState() {{
617 if (themes.style.display === "block") {{
618 hideThemeButtonState();
620 showThemeButtonState();
624 function handleThemeButtonsBlur(e) {{
625 var active = document.activeElement;
626 var related = e.relatedTarget;
628 if (active.id !== "themePicker" &&
629 (!active.parentNode || active.parentNode.id !== "theme-choices") &&
631 (related.id !== "themePicker" &&
632 (!related.parentNode || related.parentNode.id !== "theme-choices")))) {{
633 hideThemeButtonState();
637 themePicker.onclick = switchThemeButtonState;
638 themePicker.onblur = handleThemeButtonsBlur;
639 {}.forEach(function(item) {{
640 var but = document.createElement('button');
641 but.textContent = item;
642 but.onclick = function(el) {{
643 switchTheme(currentTheme, mainTheme, item, true);
645 but.onblur = handleThemeButtonsBlur;
646 themes.appendChild(but);
648 serde_json::to_string(&themes).unwrap()
651 write_minify(&cx.shared.fs, cx.path("theme.js"), &theme_js, options.enable_minification)?;
655 static_files::MAIN_JS,
656 options.enable_minification,
660 cx.path("settings.js"),
661 static_files::SETTINGS_JS,
662 options.enable_minification,
664 if cx.shared.include_sources {
667 cx.path("source-script.js"),
668 static_files::sidebar::SOURCE_SCRIPT,
669 options.enable_minification,
676 cx.path("storage.js"),
678 "var resourcesSuffix = \"{}\";{}",
679 cx.shared.resource_suffix,
680 static_files::STORAGE_JS
682 options.enable_minification,
686 if let Some(ref css) = cx.shared.layout.css_file_extension {
687 let out = cx.path("theme.css");
688 let buffer = try_err!(fs::read_to_string(css), css);
689 if !options.enable_minification {
690 cx.shared.fs.write(&out, &buffer)?;
692 write_minify(&cx.shared.fs, out, &buffer, options.enable_minification)?;
697 cx.path("normalize.css"),
698 static_files::NORMALIZE_CSS,
699 options.enable_minification,
701 write(cx.dst.join("FiraSans-Regular.woff"), static_files::fira_sans::REGULAR)?;
702 write(cx.dst.join("FiraSans-Medium.woff"), static_files::fira_sans::MEDIUM)?;
703 write(cx.dst.join("FiraSans-LICENSE.txt"), static_files::fira_sans::LICENSE)?;
704 write(cx.dst.join("SourceSerifPro-Regular.ttf.woff"), static_files::source_serif_pro::REGULAR)?;
705 write(cx.dst.join("SourceSerifPro-Bold.ttf.woff"), static_files::source_serif_pro::BOLD)?;
706 write(cx.dst.join("SourceSerifPro-It.ttf.woff"), static_files::source_serif_pro::ITALIC)?;
707 write(cx.dst.join("SourceSerifPro-LICENSE.md"), static_files::source_serif_pro::LICENSE)?;
708 write(cx.dst.join("SourceCodePro-Regular.woff"), static_files::source_code_pro::REGULAR)?;
709 write(cx.dst.join("SourceCodePro-Semibold.woff"), static_files::source_code_pro::SEMIBOLD)?;
710 write(cx.dst.join("SourceCodePro-LICENSE.txt"), static_files::source_code_pro::LICENSE)?;
711 write(cx.dst.join("LICENSE-MIT.txt"), static_files::LICENSE_MIT)?;
712 write(cx.dst.join("LICENSE-APACHE.txt"), static_files::LICENSE_APACHE)?;
713 write(cx.dst.join("COPYRIGHT.txt"), static_files::COPYRIGHT)?;
715 fn collect(path: &Path, krate: &str, key: &str) -> io::Result<(Vec<String>, Vec<String>)> {
716 let mut ret = Vec::new();
717 let mut krates = Vec::new();
720 for line in BufReader::new(File::open(path)?).lines() {
722 if !line.starts_with(key) {
725 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
728 ret.push(line.to_string());
730 line[key.len() + 2..]
733 .map(|s| s.to_owned())
734 .unwrap_or_else(|| String::new()),
741 fn show_item(item: &IndexItem, krate: &str) -> String {
743 "{{'crate':'{}','ty':{},'name':'{}','desc':'{}','p':'{}'{}}}",
747 item.desc.replace("'", "\\'"),
749 if let Some(p) = item.parent_idx { format!(",'parent':{}", p) } else { String::new() }
753 let dst = cx.dst.join(&format!("aliases{}.js", cx.shared.resource_suffix));
755 let (mut all_aliases, _) = try_err!(collect(&dst, &krate.name, "ALIASES"), &dst);
756 let mut output = String::with_capacity(100);
757 for (alias, items) in &cx.cache.aliases {
758 if items.is_empty() {
761 output.push_str(&format!(
764 items.iter().map(|v| show_item(v, &krate.name)).collect::<Vec<_>>().join(",")
767 all_aliases.push(format!("ALIASES[\"{}\"] = {{{}}};", krate.name, output));
769 let mut v = Buffer::html();
770 writeln!(&mut v, "var ALIASES = {{}};");
771 for aliases in &all_aliases {
772 writeln!(&mut v, "{}", aliases);
774 cx.shared.fs.write(&dst, v.into_inner().into_bytes())?;
777 use std::ffi::OsString;
782 children: FxHashMap<OsString, Hierarchy>,
783 elems: FxHashSet<OsString>,
787 fn new(elem: OsString) -> Hierarchy {
788 Hierarchy { elem, children: FxHashMap::default(), elems: FxHashSet::default() }
791 fn to_json_string(&self) -> String {
792 let mut subs: Vec<&Hierarchy> = self.children.values().collect();
793 subs.sort_unstable_by(|a, b| a.elem.cmp(&b.elem));
797 .map(|s| format!("\"{}\"", s.to_str().expect("invalid osstring conversion")))
798 .collect::<Vec<_>>();
799 files.sort_unstable_by(|a, b| a.cmp(b));
800 let subs = subs.iter().map(|s| s.to_json_string()).collect::<Vec<_>>().join(",");
802 if subs.is_empty() { String::new() } else { format!(",\"dirs\":[{}]", subs) };
803 let files = files.join(",");
805 if files.is_empty() { String::new() } else { format!(",\"files\":[{}]", files) };
807 "{{\"name\":\"{name}\"{dirs}{files}}}",
808 name = self.elem.to_str().expect("invalid osstring conversion"),
815 if cx.shared.include_sources {
816 let mut hierarchy = Hierarchy::new(OsString::new());
821 .filter_map(|p| p.0.strip_prefix(&cx.shared.src_root).ok())
823 let mut h = &mut hierarchy;
824 let mut elems = source
826 .filter_map(|s| match s {
827 Component::Normal(s) => Some(s.to_owned()),
832 let cur_elem = elems.next().expect("empty file path");
833 if elems.peek().is_none() {
834 h.elems.insert(cur_elem);
837 let e = cur_elem.clone();
838 h.children.entry(cur_elem.clone()).or_insert_with(|| Hierarchy::new(e));
839 h = h.children.get_mut(&cur_elem).expect("not found child");
844 let dst = cx.dst.join(&format!("source-files{}.js", cx.shared.resource_suffix));
845 let (mut all_sources, _krates) = try_err!(collect(&dst, &krate.name, "sourcesIndex"), &dst);
846 all_sources.push(format!(
847 "sourcesIndex[\"{}\"] = {};",
849 hierarchy.to_json_string()
853 "var N = null;var sourcesIndex = {{}};\n{}\ncreateSourceSidebar();\n",
854 all_sources.join("\n")
856 cx.shared.fs.write(&dst, v.as_bytes())?;
859 // Update the search index
860 let dst = cx.dst.join(&format!("search-index{}.js", cx.shared.resource_suffix));
861 let (mut all_indexes, mut krates) = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
862 all_indexes.push(search_index);
864 // Sort the indexes by crate so the file will be generated identically even
865 // with rustdoc running in parallel.
868 let mut v = String::from("var searchIndex={};\n");
869 v.push_str(&all_indexes.join("\n"));
870 // "addSearchOptions" has to be called first so the crate filtering can be set before the
871 // search might start (if it's set into the URL for example).
872 v.push_str("\naddSearchOptions(searchIndex);initSearch(searchIndex);");
873 cx.shared.fs.write(&dst, &v)?;
875 if options.enable_index_page {
876 if let Some(index_page) = options.index_page.clone() {
877 let mut md_opts = options.clone();
878 md_opts.output = cx.dst.clone();
879 md_opts.external_html = (*cx.shared).layout.external_html.clone();
881 crate::markdown::render(index_page, md_opts, diag, cx.shared.edition);
883 let dst = cx.dst.join("index.html");
884 let page = layout::Page {
885 title: "Index of crates",
888 static_root_path: cx.shared.static_root_path.as_deref(),
889 description: "List of crates",
890 keywords: BASIC_KEYWORDS,
891 resource_suffix: &cx.shared.resource_suffix,
893 static_extra_scripts: &[],
895 krates.push(krate.name.clone());
899 let content = format!(
901 <span class='in-band'>List of all crates</span>\
902 </h1><ul class='mod'>{}</ul>",
906 format!("<li><a href=\"{}index.html\">{}</li>", ensure_trailing_slash(s), s)
910 let v = layout::render(&cx.shared.layout, &page, "", content, &cx.shared.themes);
911 cx.shared.fs.write(&dst, v.as_bytes())?;
915 // Update the list of all implementors for traits
916 let dst = cx.dst.join("implementors");
917 for (&did, imps) in &cx.cache.implementors {
918 // Private modules can leak through to this phase of rustdoc, which
919 // could contain implementations for otherwise private types. In some
920 // rare cases we could find an implementation for an item which wasn't
921 // indexed, so we just skip this step in that case.
923 // FIXME: this is a vague explanation for why this can't be a `get`, in
924 // theory it should be...
925 let &(ref remote_path, remote_item_type) = match cx.cache.paths.get(&did) {
927 None => match cx.cache.external_paths.get(&did) {
940 let implementors = imps
943 // If the trait and implementation are in the same crate, then
944 // there's no need to emit information about it (there's inlining
945 // going on). If they're in different crates then the crate defining
946 // the trait will be interested in our implementation.
948 // If the implementation is from another crate then that crate
950 if imp.impl_item.def_id.krate == did.krate || !imp.impl_item.def_id.is_local() {
954 text: imp.inner_impl().print().to_string(),
955 synthetic: imp.inner_impl().synthetic,
956 types: collect_paths_for_type(imp.inner_impl().for_.clone()),
960 .collect::<Vec<_>>();
962 // Only create a js file if we have impls to add to it. If the trait is
963 // documented locally though we always create the file to avoid dead
965 if implementors.is_empty() && !cx.cache.paths.contains_key(&did) {
969 let implementors = format!(
970 r#"implementors["{}"] = {};"#,
972 serde_json::to_string(&implementors).unwrap()
975 let mut mydst = dst.clone();
976 for part in &remote_path[..remote_path.len() - 1] {
979 cx.shared.ensure_dir(&mydst)?;
980 mydst.push(&format!("{}.{}.js", remote_item_type, remote_path[remote_path.len() - 1]));
982 let (mut all_implementors, _) =
983 try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
984 all_implementors.push(implementors);
985 // Sort the implementors by crate so the file will be generated
986 // identically even with rustdoc running in parallel.
987 all_implementors.sort();
989 let mut v = String::from("(function() {var implementors = {};\n");
990 for implementor in &all_implementors {
991 writeln!(v, "{}", *implementor).unwrap();
994 "if (window.register_implementors) {\
995 window.register_implementors(implementors);\
997 window.pending_implementors = implementors;\
1001 cx.shared.fs.write(&mydst, &v)?;
1010 enable_minification: bool,
1011 ) -> Result<(), Error> {
1012 if enable_minification {
1013 if dst.extension() == Some(&OsStr::new("css")) {
1014 let res = try_none!(minifier::css::minify(contents).ok(), &dst);
1015 fs.write(dst, res.as_bytes())
1017 fs.write(dst, minifier::js::minify(contents).as_bytes())
1020 fs.write(dst, contents.as_bytes())
1024 #[derive(Debug, Eq, PartialEq, Hash)]
1031 fn new(mut url: String, name: String) -> ItemEntry {
1032 while url.starts_with('/') {
1035 ItemEntry { url, name }
1040 crate fn print(&self) -> impl fmt::Display + '_ {
1041 crate::html::format::display_fn(move |f| {
1042 write!(f, "<a href='{}'>{}</a>", self.url, Escape(&self.name))
1047 impl PartialOrd for ItemEntry {
1048 fn partial_cmp(&self, other: &ItemEntry) -> Option<::std::cmp::Ordering> {
1049 Some(self.cmp(other))
1053 impl Ord for ItemEntry {
1054 fn cmp(&self, other: &ItemEntry) -> ::std::cmp::Ordering {
1055 self.name.cmp(&other.name)
1061 structs: FxHashSet<ItemEntry>,
1062 enums: FxHashSet<ItemEntry>,
1063 unions: FxHashSet<ItemEntry>,
1064 primitives: FxHashSet<ItemEntry>,
1065 traits: FxHashSet<ItemEntry>,
1066 macros: FxHashSet<ItemEntry>,
1067 functions: FxHashSet<ItemEntry>,
1068 typedefs: FxHashSet<ItemEntry>,
1069 opaque_tys: FxHashSet<ItemEntry>,
1070 statics: FxHashSet<ItemEntry>,
1071 constants: FxHashSet<ItemEntry>,
1072 keywords: FxHashSet<ItemEntry>,
1073 attributes: FxHashSet<ItemEntry>,
1074 derives: FxHashSet<ItemEntry>,
1075 trait_aliases: FxHashSet<ItemEntry>,
1079 fn new() -> AllTypes {
1080 let new_set = |cap| FxHashSet::with_capacity_and_hasher(cap, Default::default());
1082 structs: new_set(100),
1083 enums: new_set(100),
1084 unions: new_set(100),
1085 primitives: new_set(26),
1086 traits: new_set(100),
1087 macros: new_set(100),
1088 functions: new_set(100),
1089 typedefs: new_set(100),
1090 opaque_tys: new_set(100),
1091 statics: new_set(100),
1092 constants: new_set(100),
1093 keywords: new_set(100),
1094 attributes: new_set(100),
1095 derives: new_set(100),
1096 trait_aliases: new_set(100),
1100 fn append(&mut self, item_name: String, item_type: &ItemType) {
1101 let mut url: Vec<_> = item_name.split("::").skip(1).collect();
1102 if let Some(name) = url.pop() {
1103 let new_url = format!("{}/{}.{}.html", url.join("/"), item_type, name);
1105 let name = url.join("::");
1107 ItemType::Struct => self.structs.insert(ItemEntry::new(new_url, name)),
1108 ItemType::Enum => self.enums.insert(ItemEntry::new(new_url, name)),
1109 ItemType::Union => self.unions.insert(ItemEntry::new(new_url, name)),
1110 ItemType::Primitive => self.primitives.insert(ItemEntry::new(new_url, name)),
1111 ItemType::Trait => self.traits.insert(ItemEntry::new(new_url, name)),
1112 ItemType::Macro => self.macros.insert(ItemEntry::new(new_url, name)),
1113 ItemType::Function => self.functions.insert(ItemEntry::new(new_url, name)),
1114 ItemType::Typedef => self.typedefs.insert(ItemEntry::new(new_url, name)),
1115 ItemType::OpaqueTy => self.opaque_tys.insert(ItemEntry::new(new_url, name)),
1116 ItemType::Static => self.statics.insert(ItemEntry::new(new_url, name)),
1117 ItemType::Constant => self.constants.insert(ItemEntry::new(new_url, name)),
1118 ItemType::ProcAttribute => self.attributes.insert(ItemEntry::new(new_url, name)),
1119 ItemType::ProcDerive => self.derives.insert(ItemEntry::new(new_url, name)),
1120 ItemType::TraitAlias => self.trait_aliases.insert(ItemEntry::new(new_url, name)),
1127 fn print_entries(f: &mut Buffer, e: &FxHashSet<ItemEntry>, title: &str, class: &str) {
1129 let mut e: Vec<&ItemEntry> = e.iter().collect();
1133 "<h3 id='{}'>{}</h3><ul class='{} docblock'>{}</ul>",
1137 e.iter().map(|s| format!("<li>{}</li>", s.print())).collect::<String>()
1143 fn print(self, f: &mut Buffer) {
1147 <span class='out-of-band'>\
1148 <span id='render-detail'>\
1149 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
1150 [<span class='inner'>−</span>]\
1154 <span class='in-band'>List of all items</span>\
1157 print_entries(f, &self.structs, "Structs", "structs");
1158 print_entries(f, &self.enums, "Enums", "enums");
1159 print_entries(f, &self.unions, "Unions", "unions");
1160 print_entries(f, &self.primitives, "Primitives", "primitives");
1161 print_entries(f, &self.traits, "Traits", "traits");
1162 print_entries(f, &self.macros, "Macros", "macros");
1163 print_entries(f, &self.attributes, "Attribute Macros", "attributes");
1164 print_entries(f, &self.derives, "Derive Macros", "derives");
1165 print_entries(f, &self.functions, "Functions", "functions");
1166 print_entries(f, &self.typedefs, "Typedefs", "typedefs");
1167 print_entries(f, &self.trait_aliases, "Trait Aliases", "trait-aliases");
1168 print_entries(f, &self.opaque_tys, "Opaque Types", "opaque-types");
1169 print_entries(f, &self.statics, "Statics", "statics");
1170 print_entries(f, &self.constants, "Constants", "constants")
1176 Section { description: &'static str, sub_settings: Vec<Setting> },
1177 Entry { js_data_name: &'static str, description: &'static str, default_value: bool },
1181 fn display(&self) -> String {
1183 Setting::Section { ref description, ref sub_settings } => format!(
1184 "<div class='setting-line'>\
1185 <div class='title'>{}</div>\
1186 <div class='sub-settings'>{}</div>
1189 sub_settings.iter().map(|s| s.display()).collect::<String>()
1191 Setting::Entry { ref js_data_name, ref description, ref default_value } => format!(
1192 "<div class='setting-line'>\
1193 <label class='toggle'>\
1194 <input type='checkbox' id='{}' {}>\
1195 <span class='slider'></span>\
1200 if *default_value { " checked" } else { "" },
1207 impl From<(&'static str, &'static str, bool)> for Setting {
1208 fn from(values: (&'static str, &'static str, bool)) -> Setting {
1209 Setting::Entry { js_data_name: values.0, description: values.1, default_value: values.2 }
1213 impl<T: Into<Setting>> From<(&'static str, Vec<T>)> for Setting {
1214 fn from(values: (&'static str, Vec<T>)) -> Setting {
1216 description: values.0,
1217 sub_settings: values.1.into_iter().map(|v| v.into()).collect::<Vec<_>>(),
1222 fn settings(root_path: &str, suffix: &str) -> String {
1223 // (id, explanation, default value)
1224 let settings: &[Setting] = &[
1226 "Auto-hide item declarations",
1228 ("auto-hide-struct", "Auto-hide structs declaration", true),
1229 ("auto-hide-enum", "Auto-hide enums declaration", false),
1230 ("auto-hide-union", "Auto-hide unions declaration", true),
1231 ("auto-hide-trait", "Auto-hide traits declaration", true),
1232 ("auto-hide-macro", "Auto-hide macros declaration", false),
1236 ("auto-hide-attributes", "Auto-hide item attributes.", true).into(),
1237 ("auto-hide-method-docs", "Auto-hide item methods' documentation", false).into(),
1238 ("auto-hide-trait-implementations", "Auto-hide trait implementations documentation", true)
1240 ("go-to-only-result", "Directly go to item in search if there is only one result", false)
1242 ("line-numbers", "Show line numbers on code examples", false).into(),
1243 ("disable-shortcuts", "Disable keyboard shortcuts", false).into(),
1247 <span class='in-band'>Rustdoc settings</span>\
1249 <div class='settings'>{}</div>\
1250 <script src='{}settings{}.js'></script>",
1251 settings.iter().map(|s| s.display()).collect::<String>(),
1258 fn derive_id(&self, id: String) -> String {
1259 let mut map = self.id_map.borrow_mut();
1263 /// String representation of how to get back to the root path of the 'doc/'
1264 /// folder in terms of a relative URL.
1265 fn root_path(&self) -> String {
1266 "../".repeat(self.current.len())
1269 /// Main method for rendering a crate.
1271 /// This currently isn't parallelized, but it'd be pretty easy to add
1272 /// parallelization to this function.
1273 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1274 let mut item = match krate.module.take() {
1276 None => return Ok(()),
1278 let final_file = self.dst.join(&krate.name).join("all.html");
1279 let settings_file = self.dst.join("settings.html");
1281 let crate_name = krate.name.clone();
1282 item.name = Some(krate.name);
1284 let mut all = AllTypes::new();
1287 // Render the crate documentation
1288 let mut work = vec![(self.clone(), item)];
1290 while let Some((mut cx, item)) = work.pop() {
1291 cx.item(item, &mut all, |cx, item| work.push((cx.clone(), item)))?
1295 let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
1296 if !root_path.ends_with('/') {
1297 root_path.push('/');
1299 let mut page = layout::Page {
1300 title: "List of all items in this crate",
1303 static_root_path: self.shared.static_root_path.as_deref(),
1304 description: "List of all items in this crate",
1305 keywords: BASIC_KEYWORDS,
1306 resource_suffix: &self.shared.resource_suffix,
1308 static_extra_scripts: &[],
1310 let sidebar = if let Some(ref version) = self.cache.crate_version {
1312 "<p class='location'>Crate {}</p>\
1313 <div class='block version'>\
1316 <a id='all-types' href='index.html'><p>Back to index</p></a>",
1323 let v = layout::render(
1324 &self.shared.layout,
1327 |buf: &mut Buffer| all.print(buf),
1328 &self.shared.themes,
1330 self.shared.fs.write(&final_file, v.as_bytes())?;
1332 // Generating settings page.
1333 page.title = "Rustdoc settings";
1334 page.description = "Settings of Rustdoc";
1335 page.root_path = "./";
1337 let mut themes = self.shared.themes.clone();
1338 let sidebar = "<p class='location'>Settings</p><div class='sidebar-elems'></div>";
1339 themes.push(PathBuf::from("settings.css"));
1340 let v = layout::render(
1341 &self.shared.layout,
1345 self.shared.static_root_path.as_deref().unwrap_or("./"),
1346 &self.shared.resource_suffix,
1350 self.shared.fs.write(&settings_file, v.as_bytes())?;
1355 fn render_item(&self, it: &clean::Item, pushname: bool) -> String {
1356 // A little unfortunate that this is done like this, but it sure
1357 // does make formatting *a lot* nicer.
1358 CURRENT_DEPTH.with(|slot| {
1359 slot.set(self.current.len());
1362 let mut title = if it.is_primitive() || it.is_keyword() {
1363 // No need to include the namespace for primitive types and keywords
1366 self.current.join("::")
1369 if !title.is_empty() {
1370 title.push_str("::");
1372 title.push_str(it.name.as_ref().unwrap());
1374 title.push_str(" - Rust");
1375 let tyname = it.type_();
1376 let desc = if it.is_crate() {
1377 format!("API documentation for the Rust `{}` crate.", self.shared.layout.krate)
1380 "API documentation for the Rust `{}` {} in crate `{}`.",
1381 it.name.as_ref().unwrap(),
1383 self.shared.layout.krate
1386 let keywords = make_item_keywords(it);
1387 let page = layout::Page {
1388 css_class: tyname.as_str(),
1389 root_path: &self.root_path(),
1390 static_root_path: self.shared.static_root_path.as_deref(),
1393 keywords: &keywords,
1394 resource_suffix: &self.shared.resource_suffix,
1396 static_extra_scripts: &[],
1400 self.id_map.borrow_mut().reset();
1401 self.id_map.borrow_mut().populate(initial_ids());
1404 if !self.render_redirect_pages {
1406 &self.shared.layout,
1408 |buf: &mut _| print_sidebar(self, it, buf),
1409 |buf: &mut _| print_item(self, it, buf),
1410 &self.shared.themes,
1413 let mut url = self.root_path();
1414 if let Some(&(ref names, ty)) = self.cache.paths.get(&it.def_id) {
1415 for name in &names[..names.len() - 1] {
1419 url.push_str(&item_path(ty, names.last().unwrap()));
1420 layout::redirect(&url)
1427 /// Non-parallelized version of rendering an item. This will take the input
1428 /// item, render its contents, and then invoke the specified closure with
1429 /// all sub-items which need to be rendered.
1431 /// The rendering driver uses this closure to queue up more work.
1432 fn item<F>(&mut self, item: clean::Item, all: &mut AllTypes, mut f: F) -> Result<(), Error>
1434 F: FnMut(&mut Context, clean::Item),
1436 // Stripped modules survive the rustdoc passes (i.e., `strip-private`)
1437 // if they contain impls for public types. These modules can also
1438 // contain items such as publicly re-exported structures.
1440 // External crates will provide links to these structures, so
1441 // these modules are recursed into, but not rendered normally
1442 // (a flag on the context).
1443 if !self.render_redirect_pages {
1444 self.render_redirect_pages = item.is_stripped();
1448 // modules are special because they add a namespace. We also need to
1449 // recurse into the items of the module as well.
1450 let name = item.name.as_ref().unwrap().to_string();
1451 let scx = &self.shared;
1452 if name.is_empty() {
1453 panic!("Unexpected empty destination: {:?}", self.current);
1455 let prev = self.dst.clone();
1456 self.dst.push(&name);
1457 self.current.push(name);
1459 info!("Recursing into {}", self.dst.display());
1461 let buf = self.render_item(&item, false);
1462 // buf will be empty if the module is stripped and there is no redirect for it
1463 if !buf.is_empty() {
1464 self.shared.ensure_dir(&self.dst)?;
1465 let joint_dst = self.dst.join("index.html");
1466 scx.fs.write(&joint_dst, buf.as_bytes())?;
1469 let m = match item.inner {
1470 clean::StrippedItem(box clean::ModuleItem(m)) | clean::ModuleItem(m) => m,
1471 _ => unreachable!(),
1474 // Render sidebar-items.js used throughout this module.
1475 if !self.render_redirect_pages {
1476 let items = self.build_sidebar_items(&m);
1477 let js_dst = self.dst.join("sidebar-items.js");
1478 let v = format!("initSidebarItems({});", serde_json::to_string(&items).unwrap());
1479 scx.fs.write(&js_dst, &v)?;
1482 for item in m.items {
1486 info!("Recursed; leaving {}", self.dst.display());
1488 // Go back to where we were at
1490 self.current.pop().unwrap();
1491 } else if item.name.is_some() {
1492 let buf = self.render_item(&item, true);
1493 // buf will be empty if the item is stripped and there is no redirect for it
1494 if !buf.is_empty() {
1495 let name = item.name.as_ref().unwrap();
1496 let item_type = item.type_();
1497 let file_name = &item_path(item_type, name);
1498 self.shared.ensure_dir(&self.dst)?;
1499 let joint_dst = self.dst.join(file_name);
1500 self.shared.fs.write(&joint_dst, buf.as_bytes())?;
1502 if !self.render_redirect_pages {
1503 all.append(full_path(self, &item), &item_type);
1505 if self.shared.generate_redirect_pages {
1506 // Redirect from a sane URL using the namespace to Rustdoc's
1507 // URL for the page.
1508 let redir_name = format!("{}.{}.html", name, item_type.name_space());
1509 let redir_dst = self.dst.join(redir_name);
1510 let v = layout::redirect(file_name);
1511 self.shared.fs.write(&redir_dst, v.as_bytes())?;
1513 // If the item is a macro, redirect from the old macro URL (with !)
1514 // to the new one (without).
1515 if item_type == ItemType::Macro {
1516 let redir_name = format!("{}.{}!.html", item_type, name);
1517 let redir_dst = self.dst.join(redir_name);
1518 let v = layout::redirect(file_name);
1519 self.shared.fs.write(&redir_dst, v.as_bytes())?;
1526 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
1527 // BTreeMap instead of HashMap to get a sorted output
1528 let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
1529 for item in &m.items {
1530 if item.is_stripped() {
1534 let short = item.type_();
1535 let myname = match item.name {
1537 Some(ref s) => s.to_string(),
1539 let short = short.to_string();
1542 .push((myname, Some(plain_summary_line(item.doc_value()))));
1545 if self.shared.sort_modules_alphabetically {
1546 for items in map.values_mut() {
1555 /// Generates a url appropriate for an `href` attribute back to the source of
1558 /// The url generated, when clicked, will redirect the browser back to the
1559 /// original source code.
1561 /// If `None` is returned, then a source link couldn't be generated. This
1562 /// may happen, for example, with externally inlined items where the source
1563 /// of their crate documentation isn't known.
1564 fn src_href(&self, item: &clean::Item) -> Option<String> {
1565 let mut root = self.root_path();
1567 let mut path = String::new();
1569 // We can safely ignore synthetic `SourceFile`s.
1570 let file = match item.source.filename {
1571 FileName::Real(ref path) => path,
1575 let (krate, path) = if item.def_id.is_local() {
1576 if let Some(path) = self.shared.local_sources.get(file) {
1577 (&self.shared.layout.krate, path)
1582 let (krate, src_root) = match *self.cache.extern_locations.get(&item.def_id.krate)? {
1583 (ref name, ref src, Local) => (name, src),
1584 (ref name, ref src, Remote(ref s)) => {
1585 root = s.to_string();
1588 (_, _, Unknown) => return None,
1591 sources::clean_path(&src_root, file, false, |component| {
1592 path.push_str(&component.to_string_lossy());
1595 let mut fname = file.file_name().expect("source has no filename").to_os_string();
1596 fname.push(".html");
1597 path.push_str(&fname.to_string_lossy());
1601 let lines = if item.source.loline == item.source.hiline {
1602 item.source.loline.to_string()
1604 format!("{}-{}", item.source.loline, item.source.hiline)
1607 "{root}src/{krate}/{path}#{lines}",
1608 root = Escape(&root),
1616 fn wrap_into_docblock<F>(w: &mut Buffer, f: F)
1618 F: FnOnce(&mut Buffer),
1620 write!(w, "<div class=\"docblock type-decl hidden-by-usual-hider\">");
1625 fn print_item(cx: &Context, item: &clean::Item, buf: &mut Buffer) {
1626 debug_assert!(!item.is_stripped());
1627 // Write the breadcrumb trail header for the top
1628 write!(buf, "<h1 class='fqn'><span class='out-of-band'>");
1629 if let Some(version) = item.stable_since() {
1632 "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
1638 "<span id='render-detail'>\
1639 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" \
1640 title=\"collapse all docs\">\
1641 [<span class='inner'>−</span>]\
1648 // When this item is part of a `pub use` in a downstream crate, the
1649 // [src] link in the downstream documentation will actually come back to
1650 // this page, and this link will be auto-clicked. The `id` attribute is
1651 // used to find the link to auto-click.
1652 if cx.shared.include_sources && !item.is_primitive() {
1653 if let Some(l) = cx.src_href(item) {
1654 write!(buf, "<a class='srclink' href='{}' title='{}'>[src]</a>", l, "goto source code");
1658 write!(buf, "</span>"); // out-of-band
1659 write!(buf, "<span class='in-band'>");
1660 let name = match item.inner {
1661 clean::ModuleItem(ref m) => {
1668 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) => "Function ",
1669 clean::TraitItem(..) => "Trait ",
1670 clean::StructItem(..) => "Struct ",
1671 clean::UnionItem(..) => "Union ",
1672 clean::EnumItem(..) => "Enum ",
1673 clean::TypedefItem(..) => "Type Definition ",
1674 clean::MacroItem(..) => "Macro ",
1675 clean::ProcMacroItem(ref mac) => match mac.kind {
1676 MacroKind::Bang => "Macro ",
1677 MacroKind::Attr => "Attribute Macro ",
1678 MacroKind::Derive => "Derive Macro ",
1680 clean::PrimitiveItem(..) => "Primitive Type ",
1681 clean::StaticItem(..) | clean::ForeignStaticItem(..) => "Static ",
1682 clean::ConstantItem(..) => "Constant ",
1683 clean::ForeignTypeItem => "Foreign Type ",
1684 clean::KeywordItem(..) => "Keyword ",
1685 clean::OpaqueTyItem(..) => "Opaque Type ",
1686 clean::TraitAliasItem(..) => "Trait Alias ",
1688 // We don't generate pages for any other type.
1692 buf.write_str(name);
1693 if !item.is_primitive() && !item.is_keyword() {
1694 let cur = &cx.current;
1695 let amt = if item.is_mod() { cur.len() - 1 } else { cur.len() };
1696 for (i, component) in cur.iter().enumerate().take(amt) {
1699 "<a href='{}index.html'>{}</a>::<wbr>",
1700 "../".repeat(cur.len() - i - 1),
1705 write!(buf, "<a class=\"{}\" href=''>{}</a>", item.type_(), item.name.as_ref().unwrap());
1707 write!(buf, "</span></h1>"); // in-band
1710 clean::ModuleItem(ref m) => item_module(buf, cx, item, &m.items),
1711 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) => {
1712 item_function(buf, cx, item, f)
1714 clean::TraitItem(ref t) => item_trait(buf, cx, item, t),
1715 clean::StructItem(ref s) => item_struct(buf, cx, item, s),
1716 clean::UnionItem(ref s) => item_union(buf, cx, item, s),
1717 clean::EnumItem(ref e) => item_enum(buf, cx, item, e),
1718 clean::TypedefItem(ref t, _) => item_typedef(buf, cx, item, t),
1719 clean::MacroItem(ref m) => item_macro(buf, cx, item, m),
1720 clean::ProcMacroItem(ref m) => item_proc_macro(buf, cx, item, m),
1721 clean::PrimitiveItem(_) => item_primitive(buf, cx, item),
1722 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) => item_static(buf, cx, item, i),
1723 clean::ConstantItem(ref c) => item_constant(buf, cx, item, c),
1724 clean::ForeignTypeItem => item_foreign_type(buf, cx, item),
1725 clean::KeywordItem(_) => item_keyword(buf, cx, item),
1726 clean::OpaqueTyItem(ref e, _) => item_opaque_ty(buf, cx, item, e),
1727 clean::TraitAliasItem(ref ta) => item_trait_alias(buf, cx, item, ta),
1729 // We don't generate pages for any other type.
1735 fn item_path(ty: ItemType, name: &str) -> String {
1737 ItemType::Module => format!("{}index.html", ensure_trailing_slash(name)),
1738 _ => format!("{}.{}.html", ty, name),
1742 fn full_path(cx: &Context, item: &clean::Item) -> String {
1743 let mut s = cx.current.join("::");
1745 s.push_str(item.name.as_ref().unwrap());
1750 fn plain_summary_line(s: Option<&str>) -> String {
1751 let s = s.unwrap_or("");
1752 // This essentially gets the first paragraph of text in one line.
1755 .skip_while(|line| line.chars().all(|c| c.is_whitespace()))
1756 .take_while(|line| line.chars().any(|c| !c.is_whitespace()))
1757 .fold(String::new(), |mut acc, line| {
1762 // remove final whitespace
1764 markdown::plain_summary_line(&line[..])
1767 fn shorten(s: String) -> String {
1768 if s.chars().count() > 60 {
1773 // + 1 for the added character after the word.
1774 len += p.chars().count() + 1;
1777 .collect::<Vec<_>>()
1786 fn document(w: &mut Buffer, cx: &Context, item: &clean::Item) {
1787 if let Some(ref name) = item.name {
1788 info!("Documenting {}", name);
1790 document_stability(w, cx, item, false);
1791 document_full(w, item, cx, "", false);
1794 /// Render md_text as markdown.
1799 links: Vec<(String, String)>,
1803 let mut ids = cx.id_map.borrow_mut();
1806 "<div class='docblock{}'>{}{}</div>",
1807 if is_hidden { " hidden" } else { "" },
1815 &cx.shared.playground
1825 link: AssocItemLink<'_>,
1829 if let Some(s) = item.doc_value() {
1830 let markdown = if s.contains('\n') {
1832 "{} [Read more]({})",
1833 &plain_summary_line(Some(s)),
1834 naive_assoc_href(item, link)
1837 plain_summary_line(Some(s))
1839 render_markdown(w, cx, &markdown, item.links(), prefix, is_hidden);
1840 } else if !prefix.is_empty() {
1843 "<div class='docblock{}'>{}</div>",
1844 if is_hidden { " hidden" } else { "" },
1850 fn document_full(w: &mut Buffer, item: &clean::Item, cx: &Context, prefix: &str, is_hidden: bool) {
1851 if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
1852 debug!("Doc block: =====\n{}\n=====", s);
1853 render_markdown(w, cx, &*s, item.links(), prefix, is_hidden);
1854 } else if !prefix.is_empty() {
1857 "<div class='docblock{}'>{}</div>",
1858 if is_hidden { " hidden" } else { "" },
1864 fn document_stability(w: &mut Buffer, cx: &Context, item: &clean::Item, is_hidden: bool) {
1865 let stabilities = short_stability(item, cx);
1866 if !stabilities.is_empty() {
1867 write!(w, "<div class='stability{}'>", if is_hidden { " hidden" } else { "" });
1868 for stability in stabilities {
1869 write!(w, "{}", stability);
1871 write!(w, "</div>");
1875 fn document_non_exhaustive_header(item: &clean::Item) -> &str {
1876 if item.is_non_exhaustive() { " (Non-exhaustive)" } else { "" }
1879 fn document_non_exhaustive(w: &mut Buffer, item: &clean::Item) {
1880 if item.is_non_exhaustive() {
1881 write!(w, "<div class='docblock non-exhaustive non-exhaustive-{}'>", {
1882 if item.is_struct() {
1884 } else if item.is_enum() {
1886 } else if item.is_variant() {
1893 if item.is_struct() {
1896 "Non-exhaustive structs could have additional fields added in future. \
1897 Therefore, non-exhaustive structs cannot be constructed in external crates \
1898 using the traditional <code>Struct {{ .. }}</code> syntax; cannot be \
1899 matched against without a wildcard <code>..</code>; and \
1900 struct update syntax will not work."
1902 } else if item.is_enum() {
1905 "Non-exhaustive enums could have additional variants added in future. \
1906 Therefore, when matching against variants of non-exhaustive enums, an \
1907 extra wildcard arm must be added to account for any future variants."
1909 } else if item.is_variant() {
1912 "Non-exhaustive enum variants could have additional fields added in future. \
1913 Therefore, non-exhaustive enum variants cannot be constructed in external \
1914 crates and cannot be matched against."
1919 "This type will require a wildcard arm in any match statements or \
1924 write!(w, "</div>");
1928 fn name_key(name: &str) -> (&str, u64, usize) {
1929 let end = name.bytes().rposition(|b| b.is_ascii_digit()).map_or(name.len(), |i| i + 1);
1931 // find number at end
1932 let split = name[0..end].bytes().rposition(|b| !b.is_ascii_digit()).map_or(0, |i| i + 1);
1934 // count leading zeroes
1936 name[split..end].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
1938 // sort leading zeroes last
1939 let num_zeroes = after_zeroes - split;
1941 match name[split..end].parse() {
1942 Ok(n) => (&name[..split], n, num_zeroes),
1943 Err(_) => (name, 0, num_zeroes),
1947 fn item_module(w: &mut Buffer, cx: &Context, item: &clean::Item, items: &[clean::Item]) {
1948 document(w, cx, item);
1950 let mut indices = (0..items.len()).filter(|i| !items[*i].is_stripped()).collect::<Vec<usize>>();
1952 // the order of item types in the listing
1953 fn reorder(ty: ItemType) -> u8 {
1955 ItemType::ExternCrate => 0,
1956 ItemType::Import => 1,
1957 ItemType::Primitive => 2,
1958 ItemType::Module => 3,
1959 ItemType::Macro => 4,
1960 ItemType::Struct => 5,
1961 ItemType::Enum => 6,
1962 ItemType::Constant => 7,
1963 ItemType::Static => 8,
1964 ItemType::Trait => 9,
1965 ItemType::Function => 10,
1966 ItemType::Typedef => 12,
1967 ItemType::Union => 13,
1972 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
1973 let ty1 = i1.type_();
1974 let ty2 = i2.type_();
1976 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2));
1978 let s1 = i1.stability.as_ref().map(|s| s.level);
1979 let s2 = i2.stability.as_ref().map(|s| s.level);
1981 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
1982 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
1985 let lhs = i1.name.as_ref().map_or("", |s| &**s);
1986 let rhs = i2.name.as_ref().map_or("", |s| &**s);
1987 name_key(lhs).cmp(&name_key(rhs))
1990 if cx.shared.sort_modules_alphabetically {
1991 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
1993 // This call is to remove re-export duplicates in cases such as:
1998 // pub trait Double { fn foo(); }
2002 // pub use foo::bar::*;
2006 // `Double` will appear twice in the generated docs.
2008 // FIXME: This code is quite ugly and could be improved. Small issue: DefId
2009 // can be identical even if the elements are different (mostly in imports).
2010 // So in case this is an import, we keep everything by adding a "unique id"
2011 // (which is the position in the vector).
2012 indices.dedup_by_key(|i| {
2015 if items[*i].name.as_ref().is_some() { Some(full_path(cx, &items[*i])) } else { None },
2017 if items[*i].is_import() { *i } else { 0 },
2021 debug!("{:?}", indices);
2022 let mut curty = None;
2023 for &idx in &indices {
2024 let myitem = &items[idx];
2025 if myitem.is_stripped() {
2029 let myty = Some(myitem.type_());
2030 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
2031 // Put `extern crate` and `use` re-exports in the same section.
2033 } else if myty != curty {
2034 if curty.is_some() {
2035 write!(w, "</table>");
2038 let (short, name) = item_ty_to_strs(&myty.unwrap());
2041 "<h2 id='{id}' class='section-header'>\
2042 <a href=\"#{id}\">{name}</a></h2>\n<table>",
2043 id = cx.derive_id(short.to_owned()),
2048 match myitem.inner {
2049 clean::ExternCrateItem(ref name, ref src) => {
2050 use crate::html::format::anchor;
2053 Some(ref src) => write!(
2055 "<tr><td><code>{}extern crate {} as {};",
2056 myitem.visibility.print_with_space(),
2057 anchor(myitem.def_id, src),
2062 "<tr><td><code>{}extern crate {};",
2063 myitem.visibility.print_with_space(),
2064 anchor(myitem.def_id, name)
2067 write!(w, "</code></td></tr>");
2070 clean::ImportItem(ref import) => {
2073 "<tr><td><code>{}{}</code></td></tr>",
2074 myitem.visibility.print_with_space(),
2080 if myitem.name.is_none() {
2084 let unsafety_flag = match myitem.inner {
2085 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
2086 if func.header.unsafety == hir::Unsafety::Unsafe =>
2088 "<a title='unsafe function' href='#'><sup>⚠</sup></a>"
2093 let stab = myitem.stability_class();
2094 let add = if stab.is_some() { " " } else { "" };
2096 let doc_value = myitem.doc_value().unwrap_or("");
2100 <tr class='{stab}{add}module-item'>\
2101 <td><a class=\"{class}\" href=\"{href}\" \
2102 title='{title}'>{name}</a>{unsafety_flag}</td>\
2103 <td class='docblock-short'>{stab_tags}{docs}</td>\
2105 name = *myitem.name.as_ref().unwrap(),
2106 stab_tags = stability_tags(myitem),
2107 docs = MarkdownSummaryLine(doc_value, &myitem.links()).to_string(),
2108 class = myitem.type_(),
2110 stab = stab.unwrap_or_else(|| String::new()),
2111 unsafety_flag = unsafety_flag,
2112 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
2113 title = [full_path(cx, myitem), myitem.type_().to_string()]
2115 .filter_map(|s| if !s.is_empty() { Some(s.as_str()) } else { None })
2116 .collect::<Vec<_>>()
2123 if curty.is_some() {
2124 write!(w, "</table>");
2128 /// Render the stability and deprecation tags that are displayed in the item's summary at the
2130 fn stability_tags(item: &clean::Item) -> String {
2131 let mut tags = String::new();
2133 fn tag_html(class: &str, contents: &str) -> String {
2134 format!(r#"<span class="stab {}">{}</span>"#, class, contents)
2137 // The trailing space after each tag is to space it properly against the rest of the docs.
2138 if item.deprecation().is_some() {
2139 let mut message = "Deprecated";
2140 if let Some(ref stab) = item.stability {
2141 if let Some(ref depr) = stab.deprecation {
2142 if let Some(ref since) = depr.since {
2143 if !stability::deprecation_in_effect(&since) {
2144 message = "Deprecation planned";
2149 tags += &tag_html("deprecated", message);
2152 if let Some(stab) = item.stability.as_ref().filter(|s| s.level == stability::Unstable) {
2153 if stab.feature.as_deref() == Some("rustc_private") {
2154 tags += &tag_html("internal", "Internal");
2156 tags += &tag_html("unstable", "Experimental");
2160 if let Some(ref cfg) = item.attrs.cfg {
2161 tags += &tag_html("portability", &cfg.render_short_html());
2167 /// Render the stability and/or deprecation warning that is displayed at the top of the item's
2169 fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
2170 let mut stability = vec![];
2171 let error_codes = cx.shared.codes;
2173 if let Some(Deprecation { note, since }) = &item.deprecation() {
2174 // We display deprecation messages for #[deprecated] and #[rustc_deprecated]
2175 // but only display the future-deprecation messages for #[rustc_deprecated].
2176 let mut message = if let Some(since) = since {
2177 format!("Deprecated since {}", Escape(since))
2179 String::from("Deprecated")
2181 if let Some(ref stab) = item.stability {
2182 if let Some(ref depr) = stab.deprecation {
2183 if let Some(ref since) = depr.since {
2184 if !stability::deprecation_in_effect(&since) {
2185 message = format!("Deprecating in {}", Escape(&since));
2191 if let Some(note) = note {
2192 let mut ids = cx.id_map.borrow_mut();
2193 let html = MarkdownHtml(
2198 &cx.shared.playground,
2200 message.push_str(&format!(": {}", html.to_string()));
2202 stability.push(format!("<div class='stab deprecated'>{}</div>", message));
2205 if let Some(stab) = item.stability.as_ref().filter(|stab| stab.level == stability::Unstable) {
2206 let is_rustc_private = stab.feature.as_deref() == Some("rustc_private");
2208 let mut message = if is_rustc_private {
2209 "<span class='emoji'>⚙️</span> This is an internal compiler API."
2211 "<span class='emoji'>🔬</span> This is a nightly-only experimental API."
2215 if let Some(feature) = stab.feature.as_deref() {
2216 let mut feature = format!("<code>{}</code>", Escape(&feature));
2217 if let (Some(url), Some(issue)) = (&cx.shared.issue_tracker_base_url, stab.issue) {
2218 feature.push_str(&format!(
2219 " <a href=\"{url}{issue}\">#{issue}</a>",
2225 message.push_str(&format!(" ({})", feature));
2228 if let Some(unstable_reason) = &stab.unstable_reason {
2229 // Provide a more informative message than the compiler help.
2230 let unstable_reason = if is_rustc_private {
2231 "This crate is being loaded from the sysroot, a permanently unstable location \
2232 for private compiler dependencies. It is not intended for general use. Prefer \
2233 using a public version of this crate from \
2234 [crates.io](https://crates.io) via [`Cargo.toml`]\
2235 (https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html)."
2240 let mut ids = cx.id_map.borrow_mut();
2242 "<details><summary>{}</summary>{}</details>",
2249 &cx.shared.playground,
2255 let class = if is_rustc_private { "internal" } else { "unstable" };
2256 stability.push(format!("<div class='stab {}'>{}</div>", class, message));
2259 if let Some(ref cfg) = item.attrs.cfg {
2260 stability.push(format!("<div class='stab portability'>{}</div>", cfg.render_long_html()));
2266 fn item_constant(w: &mut Buffer, cx: &Context, it: &clean::Item, c: &clean::Constant) {
2267 write!(w, "<pre class='rust const'>");
2268 render_attributes(w, it, false);
2274 vis = it.visibility.print_with_space(),
2275 name = it.name.as_ref().unwrap(),
2276 typ = c.type_.print(),
2279 if c.value.is_some() || c.is_literal {
2280 write!(w, " = {expr};", expr = Escape(&c.expr));
2285 if let Some(value) = &c.value {
2287 let value_lowercase = value.to_lowercase();
2288 let expr_lowercase = c.expr.to_lowercase();
2290 if value_lowercase != expr_lowercase
2291 && value_lowercase.trim_end_matches("i32") != expr_lowercase
2293 write!(w, " // {value}", value = Escape(value));
2298 write!(w, "</pre>");
2302 fn item_static(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Static) {
2303 write!(w, "<pre class='rust static'>");
2304 render_attributes(w, it, false);
2307 "{vis}static {mutability}\
2308 {name}: {typ}</pre>",
2309 vis = it.visibility.print_with_space(),
2310 mutability = s.mutability.print_with_space(),
2311 name = it.name.as_ref().unwrap(),
2312 typ = s.type_.print()
2317 fn item_function(w: &mut Buffer, cx: &Context, it: &clean::Item, f: &clean::Function) {
2318 let header_len = format!(
2319 "{}{}{}{}{:#}fn {}{:#}",
2320 it.visibility.print_with_space(),
2321 f.header.constness.print_with_space(),
2322 f.header.asyncness.print_with_space(),
2323 f.header.unsafety.print_with_space(),
2324 print_abi_with_space(f.header.abi),
2325 it.name.as_ref().unwrap(),
2329 write!(w, "<pre class='rust fn'>");
2330 render_attributes(w, it, false);
2333 "{vis}{constness}{asyncness}{unsafety}{abi}fn \
2334 {name}{generics}{decl}{where_clause}</pre>",
2335 vis = it.visibility.print_with_space(),
2336 constness = f.header.constness.print_with_space(),
2337 asyncness = f.header.asyncness.print_with_space(),
2338 unsafety = f.header.unsafety.print_with_space(),
2339 abi = print_abi_with_space(f.header.abi),
2340 name = it.name.as_ref().unwrap(),
2341 generics = f.generics.print(),
2342 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2343 decl = Function { decl: &f.decl, header_len, indent: 0, asyncness: f.header.asyncness }
2349 fn render_implementor(
2353 implementor_dups: &FxHashMap<&str, (DefId, bool)>,
2356 // If there's already another implementor that has the same abbridged name, use the
2357 // full path, for example in `std::iter::ExactSizeIterator`
2358 let use_absolute = match implementor.inner_impl().for_ {
2359 clean::ResolvedPath { ref path, is_generic: false, .. }
2360 | clean::BorrowedRef {
2361 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2363 } => implementor_dups[path.last_name()].1,
2370 AssocItemLink::Anchor(None),
2372 implementor.impl_item.stable_since(),
2381 fn render_impls(cx: &Context, w: &mut Buffer, traits: &[&&Impl], containing_item: &clean::Item) {
2382 let mut impls = traits
2385 let did = i.trait_did().unwrap();
2386 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2387 let mut buffer = if w.is_for_html() { Buffer::html() } else { Buffer::new() };
2394 containing_item.stable_since(),
2403 .collect::<Vec<_>>();
2405 w.write_str(&impls.join(""));
2408 fn bounds(t_bounds: &[clean::GenericBound], trait_alias: bool) -> String {
2409 let mut bounds = String::new();
2410 if !t_bounds.is_empty() {
2412 bounds.push_str(": ");
2414 for (i, p) in t_bounds.iter().enumerate() {
2416 bounds.push_str(" + ");
2418 bounds.push_str(&p.print().to_string());
2424 fn compare_impl<'a, 'b>(lhs: &'a &&Impl, rhs: &'b &&Impl) -> Ordering {
2425 let lhs = format!("{}", lhs.inner_impl().print());
2426 let rhs = format!("{}", rhs.inner_impl().print());
2428 // lhs and rhs are formatted as HTML, which may be unnecessary
2429 name_key(&lhs).cmp(&name_key(&rhs))
2432 fn item_trait(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Trait) {
2433 let bounds = bounds(&t.bounds, false);
2434 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2435 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2436 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2437 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2439 // Output the trait definition
2440 wrap_into_docblock(w, |w| {
2441 write!(w, "<pre class='rust trait'>");
2442 render_attributes(w, it, true);
2445 "{}{}{}trait {}{}{}",
2446 it.visibility.print_with_space(),
2447 t.unsafety.print_with_space(),
2448 if t.is_auto { "auto " } else { "" },
2449 it.name.as_ref().unwrap(),
2454 if !t.generics.where_predicates.is_empty() {
2455 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true });
2460 if t.items.is_empty() {
2463 // FIXME: we should be using a derived_id for the Anchors here
2466 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait);
2469 if !types.is_empty() && !consts.is_empty() {
2473 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait);
2476 if !consts.is_empty() && !required.is_empty() {
2479 for (pos, m) in required.iter().enumerate() {
2480 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait);
2483 if pos < required.len() - 1 {
2484 write!(w, "<div class='item-spacer'></div>");
2487 if !required.is_empty() && !provided.is_empty() {
2490 for (pos, m) in provided.iter().enumerate() {
2491 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait);
2493 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2494 write!(w, ",\n {{ ... }}\n");
2497 write!(w, " {{ ... }}\n");
2500 if pos < provided.len() - 1 {
2501 write!(w, "<div class='item-spacer'></div>");
2509 // Trait documentation
2510 document(w, cx, it);
2512 fn write_small_section_header(w: &mut Buffer, id: &str, title: &str, extra_content: &str) {
2516 <h2 id='{0}' class='small-section-header'>\
2517 {1}<a href='#{0}' class='anchor'></a>\
2519 id, title, extra_content
2523 fn write_loading_content(w: &mut Buffer, extra_content: &str) {
2524 write!(w, "{}<span class='loading-content'>Loading content...</span>", extra_content)
2527 fn trait_item(w: &mut Buffer, cx: &Context, m: &clean::Item, t: &clean::Item) {
2528 let name = m.name.as_ref().unwrap();
2529 let item_type = m.type_();
2530 let id = cx.derive_id(format!("{}.{}", item_type, name));
2531 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
2532 write!(w, "<h3 id='{id}' class='method'><code id='{ns_id}'>", id = id, ns_id = ns_id);
2533 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl);
2534 write!(w, "</code>");
2535 render_stability_since(w, m, t);
2540 if !types.is_empty() {
2541 write_small_section_header(
2545 "<div class='methods'>",
2548 trait_item(w, cx, *t, it);
2550 write_loading_content(w, "</div>");
2553 if !consts.is_empty() {
2554 write_small_section_header(
2557 "Associated Constants",
2558 "<div class='methods'>",
2561 trait_item(w, cx, *t, it);
2563 write_loading_content(w, "</div>");
2566 // Output the documentation for each function individually
2567 if !required.is_empty() {
2568 write_small_section_header(
2572 "<div class='methods'>",
2574 for m in &required {
2575 trait_item(w, cx, *m, it);
2577 write_loading_content(w, "</div>");
2579 if !provided.is_empty() {
2580 write_small_section_header(
2584 "<div class='methods'>",
2586 for m in &provided {
2587 trait_item(w, cx, *m, it);
2589 write_loading_content(w, "</div>");
2592 // If there are methods directly on this trait object, render them here.
2593 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All);
2595 if let Some(implementors) = cx.cache.implementors.get(&it.def_id) {
2596 // The DefId is for the first Type found with that name. The bool is
2597 // if any Types with the same name but different DefId have been found.
2598 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap::default();
2599 for implementor in implementors {
2600 match implementor.inner_impl().for_ {
2601 clean::ResolvedPath { ref path, did, is_generic: false, .. }
2602 | clean::BorrowedRef {
2603 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2606 let &mut (prev_did, ref mut has_duplicates) =
2607 implementor_dups.entry(path.last_name()).or_insert((did, false));
2608 if prev_did != did {
2609 *has_duplicates = true;
2616 let (local, foreign) = implementors.iter().partition::<Vec<_>, _>(|i| {
2617 i.inner_impl().for_.def_id().map_or(true, |d| cx.cache.paths.contains_key(&d))
2620 let (mut synthetic, mut concrete): (Vec<&&Impl>, Vec<&&Impl>) =
2621 local.iter().partition(|i| i.inner_impl().synthetic);
2623 synthetic.sort_by(compare_impl);
2624 concrete.sort_by(compare_impl);
2626 if !foreign.is_empty() {
2627 write_small_section_header(w, "foreign-impls", "Implementations on Foreign Types", "");
2629 for implementor in foreign {
2630 let assoc_link = AssocItemLink::GotoSource(
2631 implementor.impl_item.def_id,
2632 &implementor.inner_impl().provided_trait_methods,
2640 implementor.impl_item.stable_since(),
2648 write_loading_content(w, "");
2651 write_small_section_header(
2655 "<div class='item-list' id='implementors-list'>",
2657 for implementor in concrete {
2658 render_implementor(cx, implementor, w, &implementor_dups, &[]);
2660 write_loading_content(w, "</div>");
2663 write_small_section_header(
2665 "synthetic-implementors",
2666 "Auto implementors",
2667 "<div class='item-list' id='synthetic-implementors-list'>",
2669 for implementor in synthetic {
2675 &collect_paths_for_type(implementor.inner_impl().for_.clone()),
2678 write_loading_content(w, "</div>");
2681 // even without any implementations to write in, we still want the heading and list, so the
2682 // implementors javascript file pulled in below has somewhere to write the impls into
2683 write_small_section_header(
2687 "<div class='item-list' id='implementors-list'>",
2689 write_loading_content(w, "</div>");
2692 write_small_section_header(
2694 "synthetic-implementors",
2695 "Auto implementors",
2696 "<div class='item-list' id='synthetic-implementors-list'>",
2698 write_loading_content(w, "</div>");
2704 "<script type=\"text/javascript\" \
2705 src=\"{root_path}/implementors/{path}/{ty}.{name}.js\" async>\
2707 root_path = vec![".."; cx.current.len()].join("/"),
2708 path = if it.def_id.is_local() {
2709 cx.current.join("/")
2711 let (ref path, _) = cx.cache.external_paths[&it.def_id];
2712 path[..path.len() - 1].join("/")
2715 name = *it.name.as_ref().unwrap()
2719 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink<'_>) -> String {
2720 use crate::html::item_type::ItemType::*;
2722 let name = it.name.as_ref().unwrap();
2723 let ty = match it.type_() {
2724 Typedef | AssocType => AssocType,
2728 let anchor = format!("#{}.{}", ty, name);
2730 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2731 AssocItemLink::Anchor(None) => anchor,
2732 AssocItemLink::GotoSource(did, _) => {
2733 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
2742 _default: Option<&String>,
2743 link: AssocItemLink<'_>,
2748 "{}{}const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
2750 it.visibility.print_with_space(),
2751 naive_assoc_href(it, link),
2752 it.name.as_ref().unwrap(),
2760 bounds: &[clean::GenericBound],
2761 default: Option<&clean::Type>,
2762 link: AssocItemLink<'_>,
2767 "{}type <a href='{}' class=\"type\">{}</a>",
2769 naive_assoc_href(it, link),
2770 it.name.as_ref().unwrap()
2772 if !bounds.is_empty() {
2773 write!(w, ": {}", print_generic_bounds(bounds))
2775 if let Some(default) = default {
2776 write!(w, " = {}", default.print())
2780 fn render_stability_since_raw(w: &mut Buffer, ver: Option<&str>, containing_ver: Option<&str>) {
2781 if let Some(v) = ver {
2782 if containing_ver != ver && !v.is_empty() {
2783 write!(w, "<span class='since' title='Stable since Rust version {0}'>{0}</span>", v)
2788 fn render_stability_since(w: &mut Buffer, item: &clean::Item, containing_item: &clean::Item) {
2789 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
2792 fn render_assoc_item(
2795 link: AssocItemLink<'_>,
2801 header: hir::FnHeader,
2802 g: &clean::Generics,
2804 link: AssocItemLink<'_>,
2807 let name = meth.name.as_ref().unwrap();
2808 let anchor = format!("#{}.{}", meth.type_(), name);
2809 let href = match link {
2810 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2811 AssocItemLink::Anchor(None) => anchor,
2812 AssocItemLink::GotoSource(did, provided_methods) => {
2813 // We're creating a link from an impl-item to the corresponding
2814 // trait-item and need to map the anchored type accordingly.
2815 let ty = if provided_methods.contains(name) {
2821 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
2824 let mut header_len = format!(
2825 "{}{}{}{}{}{:#}fn {}{:#}",
2826 meth.visibility.print_with_space(),
2827 header.constness.print_with_space(),
2828 header.asyncness.print_with_space(),
2829 header.unsafety.print_with_space(),
2830 print_default_space(meth.is_default()),
2831 print_abi_with_space(header.abi),
2836 let (indent, end_newline) = if parent == ItemType::Trait {
2842 render_attributes(w, meth, false);
2845 "{}{}{}{}{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
2846 {generics}{decl}{where_clause}",
2847 if parent == ItemType::Trait { " " } else { "" },
2848 meth.visibility.print_with_space(),
2849 header.constness.print_with_space(),
2850 header.asyncness.print_with_space(),
2851 header.unsafety.print_with_space(),
2852 print_default_space(meth.is_default()),
2853 print_abi_with_space(header.abi),
2856 generics = g.print(),
2857 decl = Function { decl: d, header_len, indent, asyncness: header.asyncness }.print(),
2858 where_clause = WhereClause { gens: g, indent, end_newline }
2862 clean::StrippedItem(..) => {}
2863 clean::TyMethodItem(ref m) => method(w, item, m.header, &m.generics, &m.decl, link, parent),
2864 clean::MethodItem(ref m) => method(w, item, m.header, &m.generics, &m.decl, link, parent),
2865 clean::AssocConstItem(ref ty, ref default) => assoc_const(
2871 if parent == ItemType::Trait { " " } else { "" },
2873 clean::AssocTypeItem(ref bounds, ref default) => assoc_type(
2879 if parent == ItemType::Trait { " " } else { "" },
2881 _ => panic!("render_assoc_item called on non-associated-item"),
2885 fn item_struct(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Struct) {
2886 wrap_into_docblock(w, |w| {
2887 write!(w, "<pre class='rust struct'>");
2888 render_attributes(w, it, true);
2889 render_struct(w, it, Some(&s.generics), s.struct_type, &s.fields, "", true);
2893 document(w, cx, it);
2897 .filter_map(|f| match f.inner {
2898 clean::StructFieldItem(ref ty) => Some((f, ty)),
2902 if let doctree::Plain = s.struct_type {
2903 if fields.peek().is_some() {
2906 "<h2 id='fields' class='fields small-section-header'>
2907 Fields{}<a href='#fields' class='anchor'></a></h2>",
2908 document_non_exhaustive_header(it)
2910 document_non_exhaustive(w, it);
2911 for (field, ty) in fields {
2912 let id = cx.derive_id(format!(
2914 ItemType::StructField,
2915 field.name.as_ref().unwrap()
2917 let ns_id = cx.derive_id(format!(
2919 field.name.as_ref().unwrap(),
2920 ItemType::StructField.name_space()
2924 "<span id=\"{id}\" class=\"{item_type} small-section-header\">\
2925 <a href=\"#{id}\" class=\"anchor field\"></a>\
2926 <code id=\"{ns_id}\">{name}: {ty}</code>\
2928 item_type = ItemType::StructField,
2931 name = field.name.as_ref().unwrap(),
2934 document(w, cx, field);
2938 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2941 fn item_union(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Union) {
2942 wrap_into_docblock(w, |w| {
2943 write!(w, "<pre class='rust union'>");
2944 render_attributes(w, it, true);
2945 render_union(w, it, Some(&s.generics), &s.fields, "", true);
2949 document(w, cx, it);
2953 .filter_map(|f| match f.inner {
2954 clean::StructFieldItem(ref ty) => Some((f, ty)),
2958 if fields.peek().is_some() {
2961 "<h2 id='fields' class='fields small-section-header'>
2962 Fields<a href='#fields' class='anchor'></a></h2>"
2964 for (field, ty) in fields {
2965 let name = field.name.as_ref().expect("union field name");
2966 let id = format!("{}.{}", ItemType::StructField, name);
2969 "<span id=\"{id}\" class=\"{shortty} small-section-header\">\
2970 <a href=\"#{id}\" class=\"anchor field\"></a>\
2971 <code>{name}: {ty}</code>\
2975 shortty = ItemType::StructField,
2978 if let Some(stability_class) = field.stability_class() {
2979 write!(w, "<span class='stab {stab}'></span>", stab = stability_class);
2981 document(w, cx, field);
2984 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2987 fn item_enum(w: &mut Buffer, cx: &Context, it: &clean::Item, e: &clean::Enum) {
2988 wrap_into_docblock(w, |w| {
2989 write!(w, "<pre class='rust enum'>");
2990 render_attributes(w, it, true);
2994 it.visibility.print_with_space(),
2995 it.name.as_ref().unwrap(),
2997 WhereClause { gens: &e.generics, indent: 0, end_newline: true }
2999 if e.variants.is_empty() && !e.variants_stripped {
3003 for v in &e.variants {
3005 let name = v.name.as_ref().unwrap();
3007 clean::VariantItem(ref var) => match var.kind {
3008 clean::VariantKind::CLike => write!(w, "{}", name),
3009 clean::VariantKind::Tuple(ref tys) => {
3010 write!(w, "{}(", name);
3011 for (i, ty) in tys.iter().enumerate() {
3013 write!(w, ", ")
3015 write!(w, "{}", ty.print());
3019 clean::VariantKind::Struct(ref s) => {
3020 render_struct(w, v, None, s.struct_type, &s.fields, " ", false);
3023 _ => unreachable!(),
3028 if e.variants_stripped {
3029 write!(w, " // some variants omitted\n");
3036 document(w, cx, it);
3037 if !e.variants.is_empty() {
3040 "<h2 id='variants' class='variants small-section-header'>
3041 Variants{}<a href='#variants' class='anchor'></a></h2>\n",
3042 document_non_exhaustive_header(it)
3044 document_non_exhaustive(w, it);
3045 for variant in &e.variants {
3047 cx.derive_id(format!("{}.{}", ItemType::Variant, variant.name.as_ref().unwrap()));
3048 let ns_id = cx.derive_id(format!(
3050 variant.name.as_ref().unwrap(),
3051 ItemType::Variant.name_space()
3055 "<div id=\"{id}\" class=\"variant small-section-header\">\
3056 <a href=\"#{id}\" class=\"anchor field\"></a>\
3057 <code id='{ns_id}'>{name}",
3060 name = variant.name.as_ref().unwrap()
3062 if let clean::VariantItem(ref var) = variant.inner {
3063 if let clean::VariantKind::Tuple(ref tys) = var.kind {
3065 for (i, ty) in tys.iter().enumerate() {
3067 write!(w, ", ");
3069 write!(w, "{}", ty.print());
3074 write!(w, "</code></div>");
3075 document(w, cx, variant);
3076 document_non_exhaustive(w, variant);
3078 use crate::clean::{Variant, VariantKind};
3079 if let clean::VariantItem(Variant { kind: VariantKind::Struct(ref s) }) = variant.inner
3081 let variant_id = cx.derive_id(format!(
3084 variant.name.as_ref().unwrap()
3086 write!(w, "<div class='autohide sub-variant' id='{id}'>", id = variant_id);
3089 "<h3>Fields of <b>{name}</b></h3><div>",
3090 name = variant.name.as_ref().unwrap()
3092 for field in &s.fields {
3093 use crate::clean::StructFieldItem;
3094 if let StructFieldItem(ref ty) = field.inner {
3095 let id = cx.derive_id(format!(
3096 "variant.{}.field.{}",
3097 variant.name.as_ref().unwrap(),
3098 field.name.as_ref().unwrap()
3100 let ns_id = cx.derive_id(format!(
3102 variant.name.as_ref().unwrap(),
3103 ItemType::Variant.name_space(),
3104 field.name.as_ref().unwrap(),
3105 ItemType::StructField.name_space()
3109 "<span id=\"{id}\" class=\"variant small-section-header\">\
3110 <a href=\"#{id}\" class=\"anchor field\"></a>\
3111 <code id='{ns_id}'>{f}: {t}\
3115 f = field.name.as_ref().unwrap(),
3118 document(w, cx, field);
3121 write!(w, "</div></div>");
3123 render_stability_since(w, variant, it);
3126 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3129 const ATTRIBUTE_WHITELIST: &[Symbol] = &[
3136 sym::non_exhaustive,
3139 // The `top` parameter is used when generating the item declaration to ensure it doesn't have a
3140 // left padding. For example:
3142 // #[foo] <----- "top" attribute
3144 // #[bar] <---- not "top" attribute
3147 fn render_attributes(w: &mut Buffer, it: &clean::Item, top: bool) {
3148 let mut attrs = String::new();
3150 for attr in &it.attrs.other_attrs {
3151 if !ATTRIBUTE_WHITELIST.contains(&attr.name_or_empty()) {
3155 attrs.push_str(&pprust::attribute_to_string(&attr));
3157 if !attrs.is_empty() {
3160 "<span class=\"docblock attributes{}\">{}</span>",
3161 if top { " top-attr" } else { "" },
3170 g: Option<&clean::Generics>,
3171 ty: doctree::StructType,
3172 fields: &[clean::Item],
3179 it.visibility.print_with_space(),
3180 if structhead { "struct " } else { "" },
3181 it.name.as_ref().unwrap()
3183 if let Some(g) = g {
3184 write!(w, "{}", g.print())
3188 if let Some(g) = g {
3189 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })
3191 let mut has_visible_fields = false;
3193 for field in fields {
3194 if let clean::StructFieldItem(ref ty) = field.inner {
3199 field.visibility.print_with_space(),
3200 field.name.as_ref().unwrap(),
3203 has_visible_fields = true;
3207 if has_visible_fields {
3208 if it.has_stripped_fields().unwrap() {
3209 write!(w, "\n{} // some fields omitted", tab);
3211 write!(w, "\n{}", tab);
3212 } else if it.has_stripped_fields().unwrap() {
3213 // If there are no visible fields we can just display
3214 // `{ /* fields omitted */ }` to save space.
3215 write!(w, " /* fields omitted */ ");
3221 for (i, field) in fields.iter().enumerate() {
3226 clean::StrippedItem(box clean::StructFieldItem(..)) => write!(w, "_"),
3227 clean::StructFieldItem(ref ty) => {
3228 write!(w, "{}{}", field.visibility.print_with_space(), ty.print())
3230 _ => unreachable!(),
3234 if let Some(g) = g {
3235 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
3240 // Needed for PhantomData.
3241 if let Some(g) = g {
3242 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
3252 g: Option<&clean::Generics>,
3253 fields: &[clean::Item],
3260 it.visibility.print_with_space(),
3261 if structhead { "union " } else { "" },
3262 it.name.as_ref().unwrap()
3264 if let Some(g) = g {
3265 write!(w, "{}", g.print());
3266 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true });
3269 write!(w, " {{\n{}", tab);
3270 for field in fields {
3271 if let clean::StructFieldItem(ref ty) = field.inner {
3275 field.visibility.print_with_space(),
3276 field.name.as_ref().unwrap(),
3283 if it.has_stripped_fields().unwrap() {
3284 write!(w, " // some fields omitted\n{}", tab);
3289 #[derive(Copy, Clone)]
3290 enum AssocItemLink<'a> {
3291 Anchor(Option<&'a str>),
3292 GotoSource(DefId, &'a FxHashSet<String>),
3295 impl<'a> AssocItemLink<'a> {
3296 fn anchor(&self, id: &'a String) -> Self {
3298 AssocItemLink::Anchor(_) => AssocItemLink::Anchor(Some(&id)),
3299 ref other => *other,
3304 enum AssocItemRender<'a> {
3306 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool },
3309 #[derive(Copy, Clone, PartialEq)]
3312 ForDeref { mut_: bool },
3315 fn render_assoc_items(
3318 containing_item: &clean::Item,
3320 what: AssocItemRender<'_>,
3323 let v = match c.impls.get(&it) {
3327 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| i.inner_impl().trait_.is_none());
3328 if !non_trait.is_empty() {
3329 let render_mode = match what {
3330 AssocItemRender::All => {
3334 <h2 id='methods' class='small-section-header'>\
3335 Methods<a href='#methods' class='anchor'></a>\
3341 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
3345 <h2 id='deref-methods' class='small-section-header'>\
3346 Methods from {}<Target = {}>\
3347 <a href='#deref-methods' class='anchor'></a>\
3353 RenderMode::ForDeref { mut_: deref_mut_ }
3356 for i in &non_trait {
3361 AssocItemLink::Anchor(None),
3363 containing_item.stable_since(),
3372 if let AssocItemRender::DerefFor { .. } = what {
3375 if !traits.is_empty() {
3377 traits.iter().find(|t| t.inner_impl().trait_.def_id() == c.deref_trait_did);
3378 if let Some(impl_) = deref_impl {
3380 traits.iter().any(|t| t.inner_impl().trait_.def_id() == c.deref_mut_trait_did);
3381 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut);
3384 let (synthetic, concrete): (Vec<&&Impl>, Vec<&&Impl>) =
3385 traits.iter().partition(|t| t.inner_impl().synthetic);
3386 let (blanket_impl, concrete): (Vec<&&Impl>, _) =
3387 concrete.into_iter().partition(|t| t.inner_impl().blanket_impl.is_some());
3389 let mut impls = Buffer::empty_from(&w);
3390 render_impls(cx, &mut impls, &concrete, containing_item);
3391 let impls = impls.into_inner();
3392 if !impls.is_empty() {
3396 <h2 id='implementations' class='small-section-header'>\
3397 Trait Implementations<a href='#implementations' class='anchor'></a>\
3399 <div id='implementations-list'>{}</div>",
3404 if !synthetic.is_empty() {
3408 <h2 id='synthetic-implementations' class='small-section-header'>\
3409 Auto Trait Implementations\
3410 <a href='#synthetic-implementations' class='anchor'></a>\
3412 <div id='synthetic-implementations-list'>\
3415 render_impls(cx, w, &synthetic, containing_item);
3416 write!(w, "</div>");
3419 if !blanket_impl.is_empty() {
3423 <h2 id='blanket-implementations' class='small-section-header'>\
3424 Blanket Implementations\
3425 <a href='#blanket-implementations' class='anchor'></a>\
3427 <div id='blanket-implementations-list'>\
3430 render_impls(cx, w, &blanket_impl, containing_item);
3431 write!(w, "</div>");
3436 fn render_deref_methods(
3440 container_item: &clean::Item,
3443 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
3444 let (target, real_target) = impl_
3448 .filter_map(|item| match item.inner {
3449 clean::TypedefItem(ref t, true) => Some(match *t {
3450 clean::Typedef { item_type: Some(ref type_), .. } => (type_, &t.type_),
3451 _ => (&t.type_, &t.type_),
3456 .expect("Expected associated type binding");
3458 AssocItemRender::DerefFor { trait_: deref_type, type_: real_target, deref_mut_: deref_mut };
3459 if let Some(did) = target.def_id() {
3460 render_assoc_items(w, cx, container_item, did, what);
3462 if let Some(prim) = target.primitive_type() {
3463 if let Some(&did) = cx.cache.primitive_locations.get(&prim) {
3464 render_assoc_items(w, cx, container_item, did, what);
3470 fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
3471 let self_type_opt = match item.inner {
3472 clean::MethodItem(ref method) => method.decl.self_type(),
3473 clean::TyMethodItem(ref method) => method.decl.self_type(),
3477 if let Some(self_ty) = self_type_opt {
3478 let (by_mut_ref, by_box, by_value) = match self_ty {
3479 SelfTy::SelfBorrowed(_, mutability)
3480 | SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
3481 (mutability == Mutability::Mut, false, false)
3483 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
3484 (false, Some(did) == cache().owned_box_did, false)
3486 SelfTy::SelfValue => (false, false, true),
3487 _ => (false, false, false),
3490 (deref_mut_ || !by_mut_ref) && !by_box && !by_value
3500 link: AssocItemLink<'_>,
3501 render_mode: RenderMode,
3502 outer_version: Option<&str>,
3503 show_def_docs: bool,
3504 use_absolute: Option<bool>,
3505 is_on_foreign_type: bool,
3506 show_default_items: bool,
3507 // This argument is used to reference same type with different paths to avoid duplication
3508 // in documentation pages for trait with automatic implementations like "Send" and "Sync".
3511 if render_mode == RenderMode::Normal {
3512 let id = cx.derive_id(match i.inner_impl().trait_ {
3514 if is_on_foreign_type {
3515 get_id_for_impl_on_foreign_type(&i.inner_impl().for_, t)
3517 format!("impl-{}", small_url_encode(&format!("{:#}", t.print())))
3520 None => "impl".to_string(),
3522 let aliases = if aliases.is_empty() {
3525 format!(" aliases=\"{}\"", aliases.join(","))
3527 if let Some(use_absolute) = use_absolute {
3528 write!(w, "<h3 id='{}' class='impl'{}><code class='in-band'>", id, aliases);
3529 fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute);
3531 for it in &i.inner_impl().items {
3532 if let clean::TypedefItem(ref tydef, _) = it.inner {
3533 write!(w, "<span class=\"where fmt-newline\"> ");
3534 assoc_type(w, it, &[], Some(&tydef.type_), AssocItemLink::Anchor(None), "");
3535 write!(w, ";</span>");
3539 write!(w, "</code>");
3543 "<h3 id='{}' class='impl'{}><code class='in-band'>{}</code>",
3546 i.inner_impl().print()
3549 write!(w, "<a href='#{}' class='anchor'></a>", id);
3550 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
3551 render_stability_since_raw(w, since, outer_version);
3552 if let Some(l) = cx.src_href(&i.impl_item) {
3553 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>", l, "goto source code");
3556 if let Some(ref dox) = cx.shared.maybe_collapsed_doc_value(&i.impl_item) {
3557 let mut ids = cx.id_map.borrow_mut();
3560 "<div class='docblock'>{}</div>",
3563 &i.impl_item.links(),
3567 &cx.shared.playground
3578 link: AssocItemLink<'_>,
3579 render_mode: RenderMode,
3580 is_default_item: bool,
3581 outer_version: Option<&str>,
3582 trait_: Option<&clean::Trait>,
3583 show_def_docs: bool,
3585 let item_type = item.type_();
3586 let name = item.name.as_ref().unwrap();
3588 let render_method_item = match render_mode {
3589 RenderMode::Normal => true,
3590 RenderMode::ForDeref { mut_: deref_mut_ } => should_render_item(&item, deref_mut_),
3593 let (is_hidden, extra_class) =
3594 if (trait_.is_none() || item.doc_value().is_some() || item.inner.is_associated())
3602 clean::MethodItem(clean::Method { .. })
3603 | clean::TyMethodItem(clean::TyMethod { .. }) => {
3604 // Only render when the method is not static or we allow static methods
3605 if render_method_item {
3606 let id = cx.derive_id(format!("{}.{}", item_type, name));
3607 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3608 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3609 write!(w, "<code id='{}'>", ns_id);
3610 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl);
3611 write!(w, "</code>");
3612 render_stability_since_raw(w, item.stable_since(), outer_version);
3613 if let Some(l) = cx.src_href(item) {
3616 "<a class='srclink' href='{}' title='{}'>[src]</a>",
3617 l, "goto source code"
3623 clean::TypedefItem(ref tydef, _) => {
3624 let id = cx.derive_id(format!("{}.{}", ItemType::AssocType, name));
3625 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3626 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3627 write!(w, "<code id='{}'>", ns_id);
3628 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id), "");
3629 write!(w, "</code></h4>");
3631 clean::AssocConstItem(ref ty, ref default) => {
3632 let id = cx.derive_id(format!("{}.{}", item_type, name));
3633 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3634 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3635 write!(w, "<code id='{}'>", ns_id);
3636 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id), "");
3637 write!(w, "</code>");
3638 render_stability_since_raw(w, item.stable_since(), outer_version);
3639 if let Some(l) = cx.src_href(item) {
3642 "<a class='srclink' href='{}' title='{}'>[src]</a>",
3643 l, "goto source code"
3648 clean::AssocTypeItem(ref bounds, ref default) => {
3649 let id = cx.derive_id(format!("{}.{}", item_type, name));
3650 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3651 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3652 write!(w, "<code id='{}'>", ns_id);
3653 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id), "");
3654 write!(w, "</code></h4>");
3656 clean::StrippedItem(..) => return,
3657 _ => panic!("can't make docs for trait item with name {:?}", item.name),
3660 if render_method_item {
3661 if !is_default_item {
3662 if let Some(t) = trait_ {
3663 // The trait item may have been stripped so we might not
3664 // find any documentation or stability for it.
3665 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
3666 // We need the stability of the item from the trait
3667 // because impls can't have a stability.
3668 document_stability(w, cx, it, is_hidden);
3669 if item.doc_value().is_some() {
3670 document_full(w, item, cx, "", is_hidden);
3671 } else if show_def_docs {
3672 // In case the item isn't documented,
3673 // provide short documentation from the trait.
3674 document_short(w, cx, it, link, "", is_hidden);
3678 document_stability(w, cx, item, is_hidden);
3680 document_full(w, item, cx, "", is_hidden);
3684 document_stability(w, cx, item, is_hidden);
3686 document_short(w, cx, item, link, "", is_hidden);
3692 let traits = &cx.cache.traits;
3693 let trait_ = i.trait_did().map(|did| &traits[&did]);
3695 write!(w, "<div class='impl-items'>");
3696 for trait_item in &i.inner_impl().items {
3710 fn render_default_items(
3715 render_mode: RenderMode,
3716 outer_version: Option<&str>,
3717 show_def_docs: bool,
3719 for trait_item in &t.items {
3720 let n = trait_item.name.clone();
3721 if i.items.iter().any(|m| m.name == n) {
3724 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3725 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3741 // If we've implemented a trait, then also emit documentation for all
3742 // default items which weren't overridden in the implementation block.
3743 // We don't emit documentation for default items if they appear in the
3744 // Implementations on Foreign Types or Implementors sections.
3745 if show_default_items {
3746 if let Some(t) = trait_ {
3747 render_default_items(
3758 write!(w, "</div>");
3761 fn item_opaque_ty(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::OpaqueTy) {
3762 write!(w, "<pre class='rust opaque'>");
3763 render_attributes(w, it, false);
3766 "type {}{}{where_clause} = impl {bounds};</pre>",
3767 it.name.as_ref().unwrap(),
3769 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3770 bounds = bounds(&t.bounds, false)
3773 document(w, cx, it);
3775 // Render any items associated directly to this alias, as otherwise they
3776 // won't be visible anywhere in the docs. It would be nice to also show
3777 // associated items from the aliased type (see discussion in #32077), but
3778 // we need #14072 to make sense of the generics.
3779 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3782 fn item_trait_alias(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::TraitAlias) {
3783 write!(w, "<pre class='rust trait-alias'>");
3784 render_attributes(w, it, false);
3787 "trait {}{}{} = {};</pre>",
3788 it.name.as_ref().unwrap(),
3790 WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3791 bounds(&t.bounds, true)
3794 document(w, cx, it);
3796 // Render any items associated directly to this alias, as otherwise they
3797 // won't be visible anywhere in the docs. It would be nice to also show
3798 // associated items from the aliased type (see discussion in #32077), but
3799 // we need #14072 to make sense of the generics.
3800 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3803 fn item_typedef(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Typedef) {
3804 write!(w, "<pre class='rust typedef'>");
3805 render_attributes(w, it, false);
3808 "type {}{}{where_clause} = {type_};</pre>",
3809 it.name.as_ref().unwrap(),
3811 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3812 type_ = t.type_.print()
3815 document(w, cx, it);
3817 // Render any items associated directly to this alias, as otherwise they
3818 // won't be visible anywhere in the docs. It would be nice to also show
3819 // associated items from the aliased type (see discussion in #32077), but
3820 // we need #14072 to make sense of the generics.
3821 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3824 fn item_foreign_type(w: &mut Buffer, cx: &Context, it: &clean::Item) {
3825 writeln!(w, "<pre class='rust foreigntype'>extern {{");
3826 render_attributes(w, it, false);
3829 " {}type {};\n}}</pre>",
3830 it.visibility.print_with_space(),
3831 it.name.as_ref().unwrap(),
3834 document(w, cx, it);
3836 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3839 fn print_sidebar(cx: &Context, it: &clean::Item, buffer: &mut Buffer) {
3840 let parentlen = cx.current.len() - if it.is_mod() { 1 } else { 0 };
3844 || it.is_primitive()
3852 "<p class='location'>{}{}</p>",
3854 clean::StructItem(..) => "Struct ",
3855 clean::TraitItem(..) => "Trait ",
3856 clean::PrimitiveItem(..) => "Primitive Type ",
3857 clean::UnionItem(..) => "Union ",
3858 clean::EnumItem(..) => "Enum ",
3859 clean::TypedefItem(..) => "Type Definition ",
3860 clean::ForeignTypeItem => "Foreign Type ",
3861 clean::ModuleItem(..) =>
3869 it.name.as_ref().unwrap()
3874 if let Some(ref version) = cx.cache.crate_version {
3877 "<div class='block version'>\
3885 write!(buffer, "<div class=\"sidebar-elems\">");
3889 "<a id='all-types' href='all.html'><p>See all {}'s items</p></a>",
3890 it.name.as_ref().expect("crates always have a name")
3894 clean::StructItem(ref s) => sidebar_struct(buffer, it, s),
3895 clean::TraitItem(ref t) => sidebar_trait(buffer, it, t),
3896 clean::PrimitiveItem(_) => sidebar_primitive(buffer, it),
3897 clean::UnionItem(ref u) => sidebar_union(buffer, it, u),
3898 clean::EnumItem(ref e) => sidebar_enum(buffer, it, e),
3899 clean::TypedefItem(_, _) => sidebar_typedef(buffer, it),
3900 clean::ModuleItem(ref m) => sidebar_module(buffer, &m.items),
3901 clean::ForeignTypeItem => sidebar_foreign_type(buffer, it),
3905 // The sidebar is designed to display sibling functions, modules and
3906 // other miscellaneous information. since there are lots of sibling
3907 // items (and that causes quadratic growth in large modules),
3908 // we refactor common parts into a shared JavaScript file per module.
3909 // still, we don't move everything into JS because we want to preserve
3910 // as much HTML as possible in order to allow non-JS-enabled browsers
3911 // to navigate the documentation (though slightly inefficiently).
3913 write!(buffer, "<p class='location'>");
3914 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
3916 write!(buffer, "::<wbr>");
3920 "<a href='{}index.html'>{}</a>",
3921 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
3925 write!(buffer, "</p>");
3927 // Sidebar refers to the enclosing module, not this module.
3928 let relpath = if it.is_mod() { "../" } else { "" };
3931 "<script>window.sidebarCurrent = {{\
3936 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
3941 // There is no sidebar-items.js beyond the crate root path
3942 // FIXME maybe dynamic crate loading can be merged here
3944 write!(buffer, "<script defer src=\"{path}sidebar-items.js\"></script>", path = relpath);
3946 // Closes sidebar-elems div.
3947 write!(buffer, "</div>");
3950 fn get_next_url(used_links: &mut FxHashSet<String>, url: String) -> String {
3951 if used_links.insert(url.clone()) {
3955 while !used_links.insert(format!("{}-{}", url, add)) {
3958 format!("{}-{}", url, add)
3964 used_links: &mut FxHashSet<String>,
3969 .filter_map(|item| match item.name {
3970 Some(ref name) if !name.is_empty() && item.is_method() => {
3971 if !for_deref || should_render_item(item, deref_mut) {
3973 "<a href=\"#{}\">{}</a>",
3974 get_next_url(used_links, format!("method.{}", name)),
3983 .collect::<Vec<_>>()
3986 // The point is to url encode any potential character from a type with genericity.
3987 fn small_url_encode(s: &str) -> String {
3988 s.replace("<", "%3C")
3989 .replace(">", "%3E")
3990 .replace(" ", "%20")
3991 .replace("?", "%3F")
3992 .replace("'", "%27")
3993 .replace("&", "%26")
3994 .replace(",", "%2C")
3995 .replace(":", "%3A")
3996 .replace(";", "%3B")
3997 .replace("[", "%5B")
3998 .replace("]", "%5D")
3999 .replace("\"", "%22")
4002 fn sidebar_assoc_items(it: &clean::Item) -> String {
4003 let mut out = String::new();
4005 if let Some(v) = c.impls.get(&it.def_id) {
4006 let mut used_links = FxHashSet::default();
4009 let used_links_bor = &mut used_links;
4012 .filter(|i| i.inner_impl().trait_.is_none())
4013 .flat_map(move |i| get_methods(i.inner_impl(), false, used_links_bor, false))
4014 .collect::<Vec<_>>();
4015 // We want links' order to be reproducible so we don't use unstable sort.
4017 if !ret.is_empty() {
4018 out.push_str(&format!(
4019 "<a class=\"sidebar-title\" href=\"#methods\">Methods\
4020 </a><div class=\"sidebar-links\">{}</div>",
4026 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
4027 if let Some(impl_) = v
4029 .filter(|i| i.inner_impl().trait_.is_some())
4030 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did)
4032 if let Some((target, real_target)) = impl_
4036 .filter_map(|item| match item.inner {
4037 clean::TypedefItem(ref t, true) => Some(match *t {
4038 clean::Typedef { item_type: Some(ref type_), .. } => (type_, &t.type_),
4039 _ => (&t.type_, &t.type_),
4045 let inner_impl = target
4049 .and_then(|prim| c.primitive_locations.get(&prim).cloned()))
4050 .and_then(|did| c.impls.get(&did));
4051 if let Some(impls) = inner_impl {
4052 out.push_str("<a class=\"sidebar-title\" href=\"#deref-methods\">");
4053 out.push_str(&format!(
4054 "Methods from {}<Target={}>",
4057 impl_.inner_impl().trait_.as_ref().unwrap().print()
4059 Escape(&format!("{:#}", real_target.print()))
4061 out.push_str("</a>");
4064 .filter(|i| i.inner_impl().trait_.is_none())
4065 .flat_map(|i| get_methods(i.inner_impl(), true, &mut used_links, true))
4066 .collect::<Vec<_>>();
4067 // We want links' order to be reproducible so we don't use unstable sort.
4069 if !ret.is_empty() {
4070 out.push_str(&format!(
4071 "<div class=\"sidebar-links\">{}</div>",
4078 let format_impls = |impls: Vec<&Impl>| {
4079 let mut links = FxHashSet::default();
4084 let is_negative_impl = is_negative_impl(i.inner_impl());
4085 if let Some(ref i) = i.inner_impl().trait_ {
4086 let i_display = format!("{:#}", i.print());
4087 let out = Escape(&i_display);
4088 let encoded = small_url_encode(&format!("{:#}", i.print()));
4089 let generated = format!(
4090 "<a href=\"#impl-{}\">{}{}</a>",
4092 if is_negative_impl { "!" } else { "" },
4095 if links.insert(generated.clone()) { Some(generated) } else { None }
4100 .collect::<Vec<String>>();
4105 let (synthetic, concrete): (Vec<&Impl>, Vec<&Impl>) =
4106 v.iter().partition::<Vec<_>, _>(|i| i.inner_impl().synthetic);
4107 let (blanket_impl, concrete): (Vec<&Impl>, Vec<&Impl>) = concrete
4109 .partition::<Vec<_>, _>(|i| i.inner_impl().blanket_impl.is_some());
4111 let concrete_format = format_impls(concrete);
4112 let synthetic_format = format_impls(synthetic);
4113 let blanket_format = format_impls(blanket_impl);
4115 if !concrete_format.is_empty() {
4117 "<a class=\"sidebar-title\" href=\"#implementations\">\
4118 Trait Implementations</a>",
4120 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", concrete_format));
4123 if !synthetic_format.is_empty() {
4125 "<a class=\"sidebar-title\" href=\"#synthetic-implementations\">\
4126 Auto Trait Implementations</a>",
4128 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", synthetic_format));
4131 if !blanket_format.is_empty() {
4133 "<a class=\"sidebar-title\" href=\"#blanket-implementations\">\
4134 Blanket Implementations</a>",
4136 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", blanket_format));
4144 fn sidebar_struct(buf: &mut Buffer, it: &clean::Item, s: &clean::Struct) {
4145 let mut sidebar = String::new();
4146 let fields = get_struct_fields_name(&s.fields);
4148 if !fields.is_empty() {
4149 if let doctree::Plain = s.struct_type {
4150 sidebar.push_str(&format!(
4151 "<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4152 <div class=\"sidebar-links\">{}</div>",
4158 sidebar.push_str(&sidebar_assoc_items(it));
4160 if !sidebar.is_empty() {
4161 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4165 fn get_id_for_impl_on_foreign_type(for_: &clean::Type, trait_: &clean::Type) -> String {
4166 small_url_encode(&format!("impl-{:#}-for-{:#}", trait_.print(), for_.print()))
4169 fn extract_for_impl_name(item: &clean::Item) -> Option<(String, String)> {
4171 clean::ItemEnum::ImplItem(ref i) => {
4172 if let Some(ref trait_) = i.trait_ {
4174 format!("{:#}", i.for_.print()),
4175 get_id_for_impl_on_foreign_type(&i.for_, trait_),
4185 fn is_negative_impl(i: &clean::Impl) -> bool {
4186 i.polarity == Some(clean::ImplPolarity::Negative)
4189 fn sidebar_trait(buf: &mut Buffer, it: &clean::Item, t: &clean::Trait) {
4190 let mut sidebar = String::new();
4195 .filter_map(|m| match m.name {
4196 Some(ref name) if m.is_associated_type() => {
4197 Some(format!("<a href=\"#associatedtype.{name}\">{name}</a>", name = name))
4201 .collect::<String>();
4205 .filter_map(|m| match m.name {
4206 Some(ref name) if m.is_associated_const() => {
4207 Some(format!("<a href=\"#associatedconstant.{name}\">{name}</a>", name = name))
4211 .collect::<String>();
4212 let mut required = t
4215 .filter_map(|m| match m.name {
4216 Some(ref name) if m.is_ty_method() => {
4217 Some(format!("<a href=\"#tymethod.{name}\">{name}</a>", name = name))
4221 .collect::<Vec<String>>();
4222 let mut provided = t
4225 .filter_map(|m| match m.name {
4226 Some(ref name) if m.is_method() => {
4227 Some(format!("<a href=\"#method.{0}\">{0}</a>", name))
4231 .collect::<Vec<String>>();
4233 if !types.is_empty() {
4234 sidebar.push_str(&format!(
4235 "<a class=\"sidebar-title\" href=\"#associated-types\">\
4236 Associated Types</a><div class=\"sidebar-links\">{}</div>",
4240 if !consts.is_empty() {
4241 sidebar.push_str(&format!(
4242 "<a class=\"sidebar-title\" href=\"#associated-const\">\
4243 Associated Constants</a><div class=\"sidebar-links\">{}</div>",
4247 if !required.is_empty() {
4249 sidebar.push_str(&format!(
4250 "<a class=\"sidebar-title\" href=\"#required-methods\">\
4251 Required Methods</a><div class=\"sidebar-links\">{}</div>",
4255 if !provided.is_empty() {
4257 sidebar.push_str(&format!(
4258 "<a class=\"sidebar-title\" href=\"#provided-methods\">\
4259 Provided Methods</a><div class=\"sidebar-links\">{}</div>",
4266 if let Some(implementors) = c.implementors.get(&it.def_id) {
4267 let mut res = implementors
4269 .filter(|i| i.inner_impl().for_.def_id().map_or(false, |d| !c.paths.contains_key(&d)))
4270 .filter_map(|i| match extract_for_impl_name(&i.impl_item) {
4271 Some((ref name, ref id)) => {
4272 Some(format!("<a href=\"#{}\">{}</a>", id, Escape(name)))
4276 .collect::<Vec<String>>();
4277 if !res.is_empty() {
4279 sidebar.push_str(&format!(
4280 "<a class=\"sidebar-title\" href=\"#foreign-impls\">\
4281 Implementations on Foreign Types</a><div \
4282 class=\"sidebar-links\">{}</div>",
4288 sidebar.push_str("<a class=\"sidebar-title\" href=\"#implementors\">Implementors</a>");
4291 "<a class=\"sidebar-title\" \
4292 href=\"#synthetic-implementors\">Auto Implementors</a>",
4296 sidebar.push_str(&sidebar_assoc_items(it));
4298 write!(buf, "<div class=\"block items\">{}</div>", sidebar)
4301 fn sidebar_primitive(buf: &mut Buffer, it: &clean::Item) {
4302 let sidebar = sidebar_assoc_items(it);
4304 if !sidebar.is_empty() {
4305 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4309 fn sidebar_typedef(buf: &mut Buffer, it: &clean::Item) {
4310 let sidebar = sidebar_assoc_items(it);
4312 if !sidebar.is_empty() {
4313 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4317 fn get_struct_fields_name(fields: &[clean::Item]) -> String {
4320 .filter(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false })
4321 .filter_map(|f| match f.name {
4322 Some(ref name) => Some(format!(
4323 "<a href=\"#structfield.{name}\">\
4332 fn sidebar_union(buf: &mut Buffer, it: &clean::Item, u: &clean::Union) {
4333 let mut sidebar = String::new();
4334 let fields = get_struct_fields_name(&u.fields);
4336 if !fields.is_empty() {
4337 sidebar.push_str(&format!(
4338 "<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4339 <div class=\"sidebar-links\">{}</div>",
4344 sidebar.push_str(&sidebar_assoc_items(it));
4346 if !sidebar.is_empty() {
4347 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4351 fn sidebar_enum(buf: &mut Buffer, it: &clean::Item, e: &clean::Enum) {
4352 let mut sidebar = String::new();
4357 .filter_map(|v| match v.name {
4358 Some(ref name) => Some(format!(
4359 "<a href=\"#variant.{name}\">{name}\
4365 .collect::<String>();
4366 if !variants.is_empty() {
4367 sidebar.push_str(&format!(
4368 "<a class=\"sidebar-title\" href=\"#variants\">Variants</a>\
4369 <div class=\"sidebar-links\">{}</div>",
4374 sidebar.push_str(&sidebar_assoc_items(it));
4376 if !sidebar.is_empty() {
4377 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4381 fn item_ty_to_strs(ty: &ItemType) -> (&'static str, &'static str) {
4383 ItemType::ExternCrate | ItemType::Import => ("reexports", "Re-exports"),
4384 ItemType::Module => ("modules", "Modules"),
4385 ItemType::Struct => ("structs", "Structs"),
4386 ItemType::Union => ("unions", "Unions"),
4387 ItemType::Enum => ("enums", "Enums"),
4388 ItemType::Function => ("functions", "Functions"),
4389 ItemType::Typedef => ("types", "Type Definitions"),
4390 ItemType::Static => ("statics", "Statics"),
4391 ItemType::Constant => ("constants", "Constants"),
4392 ItemType::Trait => ("traits", "Traits"),
4393 ItemType::Impl => ("impls", "Implementations"),
4394 ItemType::TyMethod => ("tymethods", "Type Methods"),
4395 ItemType::Method => ("methods", "Methods"),
4396 ItemType::StructField => ("fields", "Struct Fields"),
4397 ItemType::Variant => ("variants", "Variants"),
4398 ItemType::Macro => ("macros", "Macros"),
4399 ItemType::Primitive => ("primitives", "Primitive Types"),
4400 ItemType::AssocType => ("associated-types", "Associated Types"),
4401 ItemType::AssocConst => ("associated-consts", "Associated Constants"),
4402 ItemType::ForeignType => ("foreign-types", "Foreign Types"),
4403 ItemType::Keyword => ("keywords", "Keywords"),
4404 ItemType::OpaqueTy => ("opaque-types", "Opaque Types"),
4405 ItemType::ProcAttribute => ("attributes", "Attribute Macros"),
4406 ItemType::ProcDerive => ("derives", "Derive Macros"),
4407 ItemType::TraitAlias => ("trait-aliases", "Trait aliases"),
4411 fn sidebar_module(buf: &mut Buffer, items: &[clean::Item]) {
4412 let mut sidebar = String::new();
4414 if items.iter().any(|it| it.type_() == ItemType::ExternCrate || it.type_() == ItemType::Import)
4416 sidebar.push_str(&format!(
4417 "<li><a href=\"#{id}\">{name}</a></li>",
4423 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
4424 // to print its headings
4426 ItemType::Primitive,
4440 ItemType::StructField,
4442 ItemType::AssocType,
4443 ItemType::AssocConst,
4444 ItemType::ForeignType,
4447 if items.iter().any(|it| !it.is_stripped() && it.type_() == myty) {
4448 let (short, name) = item_ty_to_strs(&myty);
4449 sidebar.push_str(&format!(
4450 "<li><a href=\"#{id}\">{name}</a></li>",
4457 if !sidebar.is_empty() {
4458 write!(buf, "<div class=\"block items\"><ul>{}</ul></div>", sidebar);
4462 fn sidebar_foreign_type(buf: &mut Buffer, it: &clean::Item) {
4463 let sidebar = sidebar_assoc_items(it);
4464 if !sidebar.is_empty() {
4465 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4469 fn item_macro(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Macro) {
4470 wrap_into_docblock(w, |w| {
4471 w.write_str(&highlight::render_with_highlighting(&t.source, Some("macro"), None, None))
4476 fn item_proc_macro(w: &mut Buffer, cx: &Context, it: &clean::Item, m: &clean::ProcMacro) {
4477 let name = it.name.as_ref().expect("proc-macros always have names");
4479 MacroKind::Bang => {
4480 write!(w, "<pre class='rust macro'>");
4481 write!(w, "{}!() {{ /* proc-macro */ }}", name);
4482 write!(w, "</pre>");
4484 MacroKind::Attr => {
4485 write!(w, "<pre class='rust attr'>");
4486 write!(w, "#[{}]", name);
4487 write!(w, "</pre>");
4489 MacroKind::Derive => {
4490 write!(w, "<pre class='rust derive'>");
4491 write!(w, "#[derive({})]", name);
4492 if !m.helpers.is_empty() {
4493 writeln!(w, "\n{{");
4494 writeln!(w, " // Attributes available to this derive:");
4495 for attr in &m.helpers {
4496 writeln!(w, " #[{}]", attr);
4500 write!(w, "</pre>");
4506 fn item_primitive(w: &mut Buffer, cx: &Context, it: &clean::Item) {
4507 document(w, cx, it);
4508 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4511 fn item_keyword(w: &mut Buffer, cx: &Context, it: &clean::Item) {
4515 crate const BASIC_KEYWORDS: &str = "rust, rustlang, rust-lang";
4517 fn make_item_keywords(it: &clean::Item) -> String {
4518 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
4521 /// Returns a list of all paths used in the type.
4522 /// This is used to help deduplicate imported impls
4523 /// for reexported types. If any of the contained
4524 /// types are re-exported, we don't use the corresponding
4525 /// entry from the js file, as inlining will have already
4526 /// picked up the impl
4527 fn collect_paths_for_type(first_ty: clean::Type) -> Vec<String> {
4528 let mut out = Vec::new();
4529 let mut visited = FxHashSet::default();
4530 let mut work = VecDeque::new();
4531 let cache = cache();
4533 work.push_back(first_ty);
4535 while let Some(ty) = work.pop_front() {
4536 if !visited.insert(ty.clone()) {
4541 clean::Type::ResolvedPath { did, .. } => {
4542 let get_extern = || cache.external_paths.get(&did).map(|s| s.0.clone());
4543 let fqp = cache.exact_paths.get(&did).cloned().or_else(get_extern);
4547 out.push(path.join("::"));
4552 clean::Type::Tuple(tys) => {
4553 work.extend(tys.into_iter());
4555 clean::Type::Slice(ty) => {
4556 work.push_back(*ty);
4558 clean::Type::Array(ty, _) => {
4559 work.push_back(*ty);
4561 clean::Type::RawPointer(_, ty) => {
4562 work.push_back(*ty);
4564 clean::Type::BorrowedRef { type_, .. } => {
4565 work.push_back(*type_);
4567 clean::Type::QPath { self_type, trait_, .. } => {
4568 work.push_back(*self_type);
4569 work.push_back(*trait_);
4577 crate fn cache() -> Arc<Cache> {
4578 CACHE_KEY.with(|c| c.borrow().clone())