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;
47 use rustc_data_structures::flock;
48 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
49 use rustc_feature::UnstableFeatures;
51 use rustc_hir::def_id::DefId;
52 use rustc_hir::Mutability;
53 use rustc_span::edition::Edition;
54 use rustc_span::hygiene::MacroKind;
55 use rustc_span::source_map::FileName;
56 use rustc_span::symbol::{sym, Symbol};
57 use serde::ser::SerializeSeq;
58 use serde::{Serialize, Serializer};
60 use syntax::print::pprust;
62 use crate::clean::{self, AttributesExt, Deprecation, GetDefId, SelfTy};
63 use crate::config::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};
84 crate use cache::ExternalLocation::{self, *};
86 /// A pair of name and its optional document.
87 pub type NameDoc = (String, Option<String>);
89 crate fn ensure_trailing_slash(v: &str) -> impl fmt::Display + '_ {
90 crate::html::format::display_fn(move |f| {
91 if !v.ends_with("/") && !v.is_empty() { write!(f, "{}/", v) } else { write!(f, "{}", v) }
101 impl error::Error for Error {}
103 impl std::fmt::Display for Error {
104 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
105 let file = self.file.display().to_string();
107 write!(f, "{}", self.error)
109 write!(f, "\"{}\": {}", self.file.display(), self.error)
114 impl PathError for Error {
115 fn new<P: AsRef<Path>>(e: io::Error, path: P) -> Error {
116 Error { file: path.as_ref().to_path_buf(), error: e }
120 macro_rules! try_none {
121 ($e:expr, $file:expr) => {{
126 return Err(Error::new(io::Error::new(io::ErrorKind::Other, "not found"), $file));
132 macro_rules! try_err {
133 ($e:expr, $file:expr) => {{
136 Err(e) => return Err(Error::new(e, $file)),
141 /// Major driving force in all rustdoc rendering. This contains information
142 /// about where in the tree-like hierarchy rendering is occurring and controls
143 /// how the current page is being rendered.
145 /// It is intended that this context is a lightweight object which can be fairly
146 /// easily cloned because it is cloned per work-job (about once per item in the
150 /// Current hierarchy of components leading down to what's currently being
152 pub current: Vec<String>,
153 /// The current destination folder of where HTML artifacts should be placed.
154 /// This changes as the context descends into the module hierarchy.
156 /// A flag, which when `true`, will render pages which redirect to the
157 /// real location of an item. This is used to allow external links to
158 /// publicly reused items to redirect to the right location.
159 pub render_redirect_pages: bool,
160 /// The map used to ensure all generated 'id=' attributes are unique.
161 id_map: Rc<RefCell<IdMap>>,
162 pub shared: Arc<SharedContext>,
163 pub cache: Arc<Cache>,
166 crate struct SharedContext {
167 /// The path to the crate root source minus the file name.
168 /// Used for simplifying paths to the highlighted source code files.
169 pub src_root: PathBuf,
170 /// This describes the layout of each page, and is not modified after
171 /// creation of the context (contains info like the favicon and added html).
172 pub layout: layout::Layout,
173 /// This flag indicates whether `[src]` links should be generated or not. If
174 /// the source files are present in the html rendering, then this will be
176 pub include_sources: bool,
177 /// The local file sources we've emitted and their respective url-paths.
178 pub local_sources: FxHashMap<PathBuf, String>,
179 /// Whether the collapsed pass ran
181 /// The base-URL of the issue tracker for when an item has been tagged with
183 pub issue_tracker_base_url: Option<String>,
184 /// The directories that have already been created in this doc run. Used to reduce the number
185 /// of spurious `create_dir_all` calls.
186 pub created_dirs: RefCell<FxHashSet<PathBuf>>,
187 /// This flag indicates whether listings of modules (in the side bar and documentation itself)
188 /// should be ordered alphabetically or in order of appearance (in the source code).
189 pub sort_modules_alphabetically: bool,
190 /// Additional themes to be added to the generated docs.
191 pub themes: Vec<PathBuf>,
192 /// Suffix to be added on resource files (if suffix is "-v2" then "light.css" becomes
194 pub resource_suffix: String,
195 /// Optional path string to be used to load static files on output pages. If not set, uses
196 /// combinations of `../` to reach the documentation root.
197 pub static_root_path: Option<String>,
198 /// Option disabled by default to generate files used by RLS and some other tools.
199 pub generate_redirect_pages: bool,
200 /// The fs handle we are working with.
202 /// The default edition used to parse doctests.
203 pub edition: Edition,
204 pub codes: ErrorCodes,
205 playground: Option<markdown::Playground>,
209 fn path(&self, filename: &str) -> PathBuf {
210 // We use splitn vs Path::extension here because we might get a filename
211 // like `style.min.css` and we want to process that into
212 // `style-suffix.min.css`. Path::extension would just return `css`
213 // which would result in `style.min-suffix.css` which isn't what we
215 let mut iter = filename.splitn(2, '.');
216 let base = iter.next().unwrap();
217 let ext = iter.next().unwrap();
218 let filename = format!("{}{}.{}", base, self.shared.resource_suffix, ext,);
219 self.dst.join(&filename)
224 crate fn ensure_dir(&self, dst: &Path) -> Result<(), Error> {
225 let mut dirs = self.created_dirs.borrow_mut();
226 if !dirs.contains(dst) {
227 try_err!(self.fs.create_dir_all(dst), dst);
228 dirs.insert(dst.to_path_buf());
234 /// Based on whether the `collapse-docs` pass was run, return either the `doc_value` or the
235 /// `collapsed_doc_value` of the given item.
236 pub fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<Cow<'a, str>> {
238 item.collapsed_doc_value().map(|s| s.into())
240 item.doc_value().map(|s| s.into())
245 /// Metadata about implementations for a type or trait.
246 #[derive(Clone, Debug)]
248 pub impl_item: clean::Item,
252 fn inner_impl(&self) -> &clean::Impl {
253 match self.impl_item.inner {
254 clean::ImplItem(ref impl_) => impl_,
255 _ => panic!("non-impl item found in impl"),
259 fn trait_did(&self) -> Option<DefId> {
260 self.inner_impl().trait_.def_id()
264 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
265 /// Later on moved into `CACHE_KEY`.
267 pub struct RenderInfo {
268 pub inlined: FxHashSet<DefId>,
269 pub external_paths: crate::core::ExternalPaths,
270 pub exact_paths: FxHashMap<DefId, Vec<String>>,
271 pub access_levels: AccessLevels<DefId>,
272 pub deref_trait_did: Option<DefId>,
273 pub deref_mut_trait_did: Option<DefId>,
274 pub owned_box_did: Option<DefId>,
277 // Helper structs for rendering items/sidebars and carrying along contextual
280 /// Struct representing one entry in the JS search index. These are all emitted
281 /// by hand to a large JS file at the end of cache-creation.
288 parent: Option<DefId>,
289 parent_idx: Option<usize>,
290 search_type: Option<IndexItemFunctionType>,
293 impl Serialize for IndexItem {
294 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
298 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
300 (self.ty, &self.name, &self.path, &self.desc, self.parent_idx, &self.search_type)
301 .serialize(serializer)
305 /// A type used for the search index.
308 name: Option<String>,
309 generics: Option<Vec<String>>,
312 impl Serialize for Type {
313 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
317 if let Some(name) = &self.name {
318 let mut seq = serializer.serialize_seq(None)?;
319 seq.serialize_element(&name)?;
320 if let Some(generics) = &self.generics {
321 seq.serialize_element(&generics)?;
325 serializer.serialize_none()
330 /// Full type of functions/methods in the search index.
332 struct IndexItemFunctionType {
334 output: Option<Vec<Type>>,
337 impl Serialize for IndexItemFunctionType {
338 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
342 // If we couldn't figure out a type, just write `null`.
343 let mut iter = self.inputs.iter();
344 if match self.output {
345 Some(ref output) => iter.chain(output.iter()).any(|ref i| i.name.is_none()),
346 None => iter.any(|ref i| i.name.is_none()),
348 serializer.serialize_none()
350 let mut seq = serializer.serialize_seq(None)?;
351 seq.serialize_element(&self.inputs)?;
352 if let Some(output) = &self.output {
353 if output.len() > 1 {
354 seq.serialize_element(&output)?;
356 seq.serialize_element(&output[0])?;
364 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
365 thread_local!(pub static CURRENT_DEPTH: Cell<usize> = Cell::new(0));
367 pub fn initial_ids() -> Vec<String> {
379 "synthetic-implementors",
381 "synthetic-implementors-list",
387 .map(|id| (String::from(*id)))
391 /// Generates the documentation for `crate` into the directory `dst`
393 mut krate: clean::Crate,
394 options: RenderOptions,
395 renderinfo: RenderInfo,
396 diag: &rustc_errors::Handler,
398 ) -> Result<(), Error> {
399 // need to save a copy of the options for rendering the index page
400 let md_opts = options.clone();
406 sort_modules_alphabetically,
409 extern_html_root_urls,
412 generate_search_filter,
413 generate_redirect_pages,
417 let src_root = match krate.src {
418 FileName::Real(ref p) => match p.parent() {
419 Some(p) => p.to_path_buf(),
420 None => PathBuf::new(),
424 let mut errors = Arc::new(ErrorStorage::new());
425 // If user passed in `--playground-url` arg, we fill in crate name here
426 let mut playground = None;
427 if let Some(url) = playground_url {
428 playground = Some(markdown::Playground { crate_name: Some(krate.name.clone()), url });
430 let mut layout = layout::Layout {
432 favicon: String::new(),
434 krate: krate.name.clone(),
435 css_file_extension: extension_css,
436 generate_search_filter,
438 let mut issue_tracker_base_url = None;
439 let mut include_sources = true;
441 // Crawl the crate attributes looking for attributes which control how we're
442 // going to emit HTML
443 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
444 for attr in attrs.lists(sym::doc) {
445 match (attr.name_or_empty(), attr.value_str()) {
446 (sym::html_favicon_url, Some(s)) => {
447 layout.favicon = s.to_string();
449 (sym::html_logo_url, Some(s)) => {
450 layout.logo = s.to_string();
452 (sym::html_playground_url, Some(s)) => {
453 playground = Some(markdown::Playground {
454 crate_name: Some(krate.name.clone()),
458 (sym::issue_tracker_base_url, Some(s)) => {
459 issue_tracker_base_url = Some(s.to_string());
461 (sym::html_no_source, None) if attr.is_word() => {
462 include_sources = false;
468 let mut scx = SharedContext {
469 collapsed: krate.collapsed,
472 local_sources: Default::default(),
473 issue_tracker_base_url,
475 created_dirs: Default::default(),
476 sort_modules_alphabetically,
480 generate_redirect_pages,
481 fs: DocFS::new(&errors),
483 codes: ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build()),
488 scx.ensure_dir(&dst)?;
489 krate = sources::render(&dst, &mut scx, krate)?;
490 let (new_crate, index, cache) =
491 Cache::from_krate(renderinfo, &extern_html_root_urls, &dst, krate);
493 let cache = Arc::new(cache);
494 let mut cx = Context {
497 render_redirect_pages: false,
498 id_map: Rc::new(RefCell::new(id_map)),
499 shared: Arc::new(scx),
500 cache: cache.clone(),
503 // Freeze the cache now that the index has been built. Put an Arc into TLS
504 // for future parallelization opportunities
505 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
506 CURRENT_DEPTH.with(|s| s.set(0));
508 // Write shared runs within a flock; disable thread dispatching of IO temporarily.
509 Arc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(true);
510 write_shared(&cx, &krate, index, &md_opts, diag)?;
511 Arc::get_mut(&mut cx.shared).unwrap().fs.set_sync_only(false);
513 // And finally render the whole crate's documentation
514 let ret = cx.krate(krate);
515 let nb_errors = Arc::get_mut(&mut errors).map_or_else(|| 0, |errors| errors.write_errors(diag));
518 } else if nb_errors > 0 {
519 Err(Error::new(io::Error::new(io::ErrorKind::Other, "I/O error"), ""))
527 krate: &clean::Crate,
528 search_index: String,
529 options: &RenderOptions,
530 diag: &rustc_errors::Handler,
531 ) -> Result<(), Error> {
532 // Write out the shared files. Note that these are shared among all rustdoc
533 // docs placed in the output directory, so this needs to be a synchronized
534 // operation with respect to all other rustdocs running around.
535 let lock_file = cx.dst.join(".lock");
536 let _lock = try_err!(flock::Lock::new(&lock_file, true, true, true), &lock_file);
538 // Add all the static files. These may already exist, but we just
539 // overwrite them anyway to make sure that they're fresh and up-to-date.
543 cx.path("rustdoc.css"),
544 static_files::RUSTDOC_CSS,
545 options.enable_minification,
549 cx.path("settings.css"),
550 static_files::SETTINGS_CSS,
551 options.enable_minification,
555 cx.path("noscript.css"),
556 static_files::NOSCRIPT_CSS,
557 options.enable_minification,
560 // To avoid "light.css" to be overwritten, we'll first run over the received themes and only
561 // then we'll run over the "official" styles.
562 let mut themes: FxHashSet<String> = FxHashSet::default();
564 for entry in &cx.shared.themes {
565 let content = try_err!(fs::read(&entry), &entry);
566 let theme = try_none!(try_none!(entry.file_stem(), &entry).to_str(), &entry);
567 let extension = try_none!(try_none!(entry.extension(), &entry).to_str(), &entry);
568 cx.shared.fs.write(cx.path(&format!("{}.{}", theme, extension)), content.as_slice())?;
569 themes.insert(theme.to_owned());
572 let write = |p, c| cx.shared.fs.write(p, c);
573 if (*cx.shared).layout.logo.is_empty() {
574 write(cx.path("rust-logo.png"), static_files::RUST_LOGO)?;
576 if (*cx.shared).layout.favicon.is_empty() {
577 write(cx.path("favicon.ico"), static_files::RUST_FAVICON)?;
579 write(cx.path("brush.svg"), static_files::BRUSH_SVG)?;
580 write(cx.path("wheel.svg"), static_files::WHEEL_SVG)?;
581 write(cx.path("down-arrow.svg"), static_files::DOWN_ARROW_SVG)?;
584 cx.path("light.css"),
585 static_files::themes::LIGHT,
586 options.enable_minification,
588 themes.insert("light".to_owned());
592 static_files::themes::DARK,
593 options.enable_minification,
595 themes.insert("dark".to_owned());
597 let mut themes: Vec<&String> = themes.iter().collect();
599 // To avoid theme switch latencies as much as possible, we put everything theme related
600 // at the beginning of the html files into another js file.
601 let theme_js = format!(
602 r#"var themes = document.getElementById("theme-choices");
603 var themePicker = document.getElementById("theme-picker");
605 function showThemeButtonState() {{
606 themes.style.display = "block";
607 themePicker.style.borderBottomRightRadius = "0";
608 themePicker.style.borderBottomLeftRadius = "0";
611 function hideThemeButtonState() {{
612 themes.style.display = "none";
613 themePicker.style.borderBottomRightRadius = "3px";
614 themePicker.style.borderBottomLeftRadius = "3px";
617 function switchThemeButtonState() {{
618 if (themes.style.display === "block") {{
619 hideThemeButtonState();
621 showThemeButtonState();
625 function handleThemeButtonsBlur(e) {{
626 var active = document.activeElement;
627 var related = e.relatedTarget;
629 if (active.id !== "themePicker" &&
630 (!active.parentNode || active.parentNode.id !== "theme-choices") &&
632 (related.id !== "themePicker" &&
633 (!related.parentNode || related.parentNode.id !== "theme-choices")))) {{
634 hideThemeButtonState();
638 themePicker.onclick = switchThemeButtonState;
639 themePicker.onblur = handleThemeButtonsBlur;
640 {}.forEach(function(item) {{
641 var but = document.createElement('button');
642 but.textContent = item;
643 but.onclick = function(el) {{
644 switchTheme(currentTheme, mainTheme, item, true);
646 but.onblur = handleThemeButtonsBlur;
647 themes.appendChild(but);
649 serde_json::to_string(&themes).unwrap()
652 write_minify(&cx.shared.fs, cx.path("theme.js"), &theme_js, options.enable_minification)?;
656 static_files::MAIN_JS,
657 options.enable_minification,
661 cx.path("settings.js"),
662 static_files::SETTINGS_JS,
663 options.enable_minification,
665 if cx.shared.include_sources {
668 cx.path("source-script.js"),
669 static_files::sidebar::SOURCE_SCRIPT,
670 options.enable_minification,
677 cx.path("storage.js"),
679 "var resourcesSuffix = \"{}\";{}",
680 cx.shared.resource_suffix,
681 static_files::STORAGE_JS
683 options.enable_minification,
687 if let Some(ref css) = cx.shared.layout.css_file_extension {
688 let out = cx.path("theme.css");
689 let buffer = try_err!(fs::read_to_string(css), css);
690 if !options.enable_minification {
691 cx.shared.fs.write(&out, &buffer)?;
693 write_minify(&cx.shared.fs, out, &buffer, options.enable_minification)?;
698 cx.path("normalize.css"),
699 static_files::NORMALIZE_CSS,
700 options.enable_minification,
702 write(cx.dst.join("FiraSans-Regular.woff"), static_files::fira_sans::REGULAR)?;
703 write(cx.dst.join("FiraSans-Medium.woff"), static_files::fira_sans::MEDIUM)?;
704 write(cx.dst.join("FiraSans-LICENSE.txt"), static_files::fira_sans::LICENSE)?;
705 write(cx.dst.join("SourceSerifPro-Regular.ttf.woff"), static_files::source_serif_pro::REGULAR)?;
706 write(cx.dst.join("SourceSerifPro-Bold.ttf.woff"), static_files::source_serif_pro::BOLD)?;
707 write(cx.dst.join("SourceSerifPro-It.ttf.woff"), static_files::source_serif_pro::ITALIC)?;
708 write(cx.dst.join("SourceSerifPro-LICENSE.md"), static_files::source_serif_pro::LICENSE)?;
709 write(cx.dst.join("SourceCodePro-Regular.woff"), static_files::source_code_pro::REGULAR)?;
710 write(cx.dst.join("SourceCodePro-Semibold.woff"), static_files::source_code_pro::SEMIBOLD)?;
711 write(cx.dst.join("SourceCodePro-LICENSE.txt"), static_files::source_code_pro::LICENSE)?;
712 write(cx.dst.join("LICENSE-MIT.txt"), static_files::LICENSE_MIT)?;
713 write(cx.dst.join("LICENSE-APACHE.txt"), static_files::LICENSE_APACHE)?;
714 write(cx.dst.join("COPYRIGHT.txt"), static_files::COPYRIGHT)?;
716 fn collect(path: &Path, krate: &str, key: &str) -> io::Result<(Vec<String>, Vec<String>)> {
717 let mut ret = Vec::new();
718 let mut krates = Vec::new();
721 for line in BufReader::new(File::open(path)?).lines() {
723 if !line.starts_with(key) {
726 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
729 ret.push(line.to_string());
731 line[key.len() + 2..]
734 .map(|s| s.to_owned())
735 .unwrap_or_else(|| String::new()),
742 fn show_item(item: &IndexItem, krate: &str) -> String {
744 "{{'crate':'{}','ty':{},'name':'{}','desc':'{}','p':'{}'{}}}",
748 item.desc.replace("'", "\\'"),
750 if let Some(p) = item.parent_idx { format!(",'parent':{}", p) } else { String::new() }
754 let dst = cx.dst.join(&format!("aliases{}.js", cx.shared.resource_suffix));
756 let (mut all_aliases, _) = try_err!(collect(&dst, &krate.name, "ALIASES"), &dst);
757 let mut output = String::with_capacity(100);
758 for (alias, items) in &cx.cache.aliases {
759 if items.is_empty() {
762 output.push_str(&format!(
765 items.iter().map(|v| show_item(v, &krate.name)).collect::<Vec<_>>().join(",")
768 all_aliases.push(format!("ALIASES[\"{}\"] = {{{}}};", krate.name, output));
770 let mut v = Buffer::html();
771 writeln!(&mut v, "var ALIASES = {{}};");
772 for aliases in &all_aliases {
773 writeln!(&mut v, "{}", aliases);
775 cx.shared.fs.write(&dst, v.into_inner().into_bytes())?;
778 use std::ffi::OsString;
783 children: FxHashMap<OsString, Hierarchy>,
784 elems: FxHashSet<OsString>,
788 fn new(elem: OsString) -> Hierarchy {
789 Hierarchy { elem, children: FxHashMap::default(), elems: FxHashSet::default() }
792 fn to_json_string(&self) -> String {
793 let mut subs: Vec<&Hierarchy> = self.children.values().collect();
794 subs.sort_unstable_by(|a, b| a.elem.cmp(&b.elem));
798 .map(|s| format!("\"{}\"", s.to_str().expect("invalid osstring conversion")))
799 .collect::<Vec<_>>();
800 files.sort_unstable_by(|a, b| a.cmp(b));
801 let subs = subs.iter().map(|s| s.to_json_string()).collect::<Vec<_>>().join(",");
803 if subs.is_empty() { String::new() } else { format!(",\"dirs\":[{}]", subs) };
804 let files = files.join(",");
806 if files.is_empty() { String::new() } else { format!(",\"files\":[{}]", files) };
808 "{{\"name\":\"{name}\"{dirs}{files}}}",
809 name = self.elem.to_str().expect("invalid osstring conversion"),
816 if cx.shared.include_sources {
817 let mut hierarchy = Hierarchy::new(OsString::new());
822 .filter_map(|p| p.0.strip_prefix(&cx.shared.src_root).ok())
824 let mut h = &mut hierarchy;
825 let mut elems = source
827 .filter_map(|s| match s {
828 Component::Normal(s) => Some(s.to_owned()),
833 let cur_elem = elems.next().expect("empty file path");
834 if elems.peek().is_none() {
835 h.elems.insert(cur_elem);
838 let e = cur_elem.clone();
839 h.children.entry(cur_elem.clone()).or_insert_with(|| Hierarchy::new(e));
840 h = h.children.get_mut(&cur_elem).expect("not found child");
845 let dst = cx.dst.join(&format!("source-files{}.js", cx.shared.resource_suffix));
846 let (mut all_sources, _krates) = try_err!(collect(&dst, &krate.name, "sourcesIndex"), &dst);
847 all_sources.push(format!(
848 "sourcesIndex[\"{}\"] = {};",
850 hierarchy.to_json_string()
854 "var N = null;var sourcesIndex = {{}};\n{}\ncreateSourceSidebar();\n",
855 all_sources.join("\n")
857 cx.shared.fs.write(&dst, v.as_bytes())?;
860 // Update the search index
861 let dst = cx.dst.join(&format!("search-index{}.js", cx.shared.resource_suffix));
862 let (mut all_indexes, mut krates) = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
863 all_indexes.push(search_index);
865 // Sort the indexes by crate so the file will be generated identically even
866 // with rustdoc running in parallel.
869 let mut v = String::from("var searchIndex={};\n");
870 v.push_str(&all_indexes.join("\n"));
871 // "addSearchOptions" has to be called first so the crate filtering can be set before the
872 // search might start (if it's set into the URL for example).
873 v.push_str("\naddSearchOptions(searchIndex);initSearch(searchIndex);");
874 cx.shared.fs.write(&dst, &v)?;
876 if options.enable_index_page {
877 if let Some(index_page) = options.index_page.clone() {
878 let mut md_opts = options.clone();
879 md_opts.output = cx.dst.clone();
880 md_opts.external_html = (*cx.shared).layout.external_html.clone();
882 crate::markdown::render(index_page, md_opts, diag, cx.shared.edition);
884 let dst = cx.dst.join("index.html");
885 let page = layout::Page {
886 title: "Index of crates",
889 static_root_path: cx.shared.static_root_path.as_deref(),
890 description: "List of crates",
891 keywords: BASIC_KEYWORDS,
892 resource_suffix: &cx.shared.resource_suffix,
894 static_extra_scripts: &[],
896 krates.push(krate.name.clone());
900 let content = format!(
902 <span class='in-band'>List of all crates</span>\
903 </h1><ul class='mod'>{}</ul>",
907 format!("<li><a href=\"{}index.html\">{}</li>", ensure_trailing_slash(s), s)
911 let v = layout::render(&cx.shared.layout, &page, "", content, &cx.shared.themes);
912 cx.shared.fs.write(&dst, v.as_bytes())?;
916 // Update the list of all implementors for traits
917 let dst = cx.dst.join("implementors");
918 for (&did, imps) in &cx.cache.implementors {
919 // Private modules can leak through to this phase of rustdoc, which
920 // could contain implementations for otherwise private types. In some
921 // rare cases we could find an implementation for an item which wasn't
922 // indexed, so we just skip this step in that case.
924 // FIXME: this is a vague explanation for why this can't be a `get`, in
925 // theory it should be...
926 let &(ref remote_path, remote_item_type) = match cx.cache.paths.get(&did) {
928 None => match cx.cache.external_paths.get(&did) {
941 let implementors = imps
944 // If the trait and implementation are in the same crate, then
945 // there's no need to emit information about it (there's inlining
946 // going on). If they're in different crates then the crate defining
947 // the trait will be interested in our implementation.
949 // If the implementation is from another crate then that crate
951 if imp.impl_item.def_id.krate == did.krate || !imp.impl_item.def_id.is_local() {
955 text: imp.inner_impl().print().to_string(),
956 synthetic: imp.inner_impl().synthetic,
957 types: collect_paths_for_type(imp.inner_impl().for_.clone()),
961 .collect::<Vec<_>>();
963 // Only create a js file if we have impls to add to it. If the trait is
964 // documented locally though we always create the file to avoid dead
966 if implementors.is_empty() && !cx.cache.paths.contains_key(&did) {
970 let implementors = format!(
971 r#"implementors["{}"] = {};"#,
973 serde_json::to_string(&implementors).unwrap()
976 let mut mydst = dst.clone();
977 for part in &remote_path[..remote_path.len() - 1] {
980 cx.shared.ensure_dir(&mydst)?;
981 mydst.push(&format!("{}.{}.js", remote_item_type, remote_path[remote_path.len() - 1]));
983 let (mut all_implementors, _) =
984 try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
985 all_implementors.push(implementors);
986 // Sort the implementors by crate so the file will be generated
987 // identically even with rustdoc running in parallel.
988 all_implementors.sort();
990 let mut v = String::from("(function() {var implementors = {};\n");
991 for implementor in &all_implementors {
992 writeln!(v, "{}", *implementor).unwrap();
996 if (window.register_implementors) {
997 window.register_implementors(implementors);
999 window.pending_implementors = implementors;
1004 cx.shared.fs.write(&mydst, &v)?;
1013 enable_minification: bool,
1014 ) -> Result<(), Error> {
1015 if enable_minification {
1016 if dst.extension() == Some(&OsStr::new("css")) {
1017 let res = try_none!(minifier::css::minify(contents).ok(), &dst);
1018 fs.write(dst, res.as_bytes())
1020 fs.write(dst, minifier::js::minify(contents).as_bytes())
1023 fs.write(dst, contents.as_bytes())
1027 #[derive(Debug, Eq, PartialEq, Hash)]
1034 fn new(mut url: String, name: String) -> ItemEntry {
1035 while url.starts_with('/') {
1038 ItemEntry { url, name }
1043 crate fn print(&self) -> impl fmt::Display + '_ {
1044 crate::html::format::display_fn(move |f| {
1045 write!(f, "<a href='{}'>{}</a>", self.url, Escape(&self.name))
1050 impl PartialOrd for ItemEntry {
1051 fn partial_cmp(&self, other: &ItemEntry) -> Option<::std::cmp::Ordering> {
1052 Some(self.cmp(other))
1056 impl Ord for ItemEntry {
1057 fn cmp(&self, other: &ItemEntry) -> ::std::cmp::Ordering {
1058 self.name.cmp(&other.name)
1064 structs: FxHashSet<ItemEntry>,
1065 enums: FxHashSet<ItemEntry>,
1066 unions: FxHashSet<ItemEntry>,
1067 primitives: FxHashSet<ItemEntry>,
1068 traits: FxHashSet<ItemEntry>,
1069 macros: FxHashSet<ItemEntry>,
1070 functions: FxHashSet<ItemEntry>,
1071 typedefs: FxHashSet<ItemEntry>,
1072 opaque_tys: FxHashSet<ItemEntry>,
1073 statics: FxHashSet<ItemEntry>,
1074 constants: FxHashSet<ItemEntry>,
1075 keywords: FxHashSet<ItemEntry>,
1076 attributes: FxHashSet<ItemEntry>,
1077 derives: FxHashSet<ItemEntry>,
1078 trait_aliases: FxHashSet<ItemEntry>,
1082 fn new() -> AllTypes {
1083 let new_set = |cap| FxHashSet::with_capacity_and_hasher(cap, Default::default());
1085 structs: new_set(100),
1086 enums: new_set(100),
1087 unions: new_set(100),
1088 primitives: new_set(26),
1089 traits: new_set(100),
1090 macros: new_set(100),
1091 functions: new_set(100),
1092 typedefs: new_set(100),
1093 opaque_tys: new_set(100),
1094 statics: new_set(100),
1095 constants: new_set(100),
1096 keywords: new_set(100),
1097 attributes: new_set(100),
1098 derives: new_set(100),
1099 trait_aliases: new_set(100),
1103 fn append(&mut self, item_name: String, item_type: &ItemType) {
1104 let mut url: Vec<_> = item_name.split("::").skip(1).collect();
1105 if let Some(name) = url.pop() {
1106 let new_url = format!("{}/{}.{}.html", url.join("/"), item_type, name);
1108 let name = url.join("::");
1110 ItemType::Struct => self.structs.insert(ItemEntry::new(new_url, name)),
1111 ItemType::Enum => self.enums.insert(ItemEntry::new(new_url, name)),
1112 ItemType::Union => self.unions.insert(ItemEntry::new(new_url, name)),
1113 ItemType::Primitive => self.primitives.insert(ItemEntry::new(new_url, name)),
1114 ItemType::Trait => self.traits.insert(ItemEntry::new(new_url, name)),
1115 ItemType::Macro => self.macros.insert(ItemEntry::new(new_url, name)),
1116 ItemType::Function => self.functions.insert(ItemEntry::new(new_url, name)),
1117 ItemType::Typedef => self.typedefs.insert(ItemEntry::new(new_url, name)),
1118 ItemType::OpaqueTy => self.opaque_tys.insert(ItemEntry::new(new_url, name)),
1119 ItemType::Static => self.statics.insert(ItemEntry::new(new_url, name)),
1120 ItemType::Constant => self.constants.insert(ItemEntry::new(new_url, name)),
1121 ItemType::ProcAttribute => self.attributes.insert(ItemEntry::new(new_url, name)),
1122 ItemType::ProcDerive => self.derives.insert(ItemEntry::new(new_url, name)),
1123 ItemType::TraitAlias => self.trait_aliases.insert(ItemEntry::new(new_url, name)),
1130 fn print_entries(f: &mut Buffer, e: &FxHashSet<ItemEntry>, title: &str, class: &str) {
1132 let mut e: Vec<&ItemEntry> = e.iter().collect();
1136 "<h3 id='{}'>{}</h3><ul class='{} docblock'>{}</ul>",
1140 e.iter().map(|s| format!("<li>{}</li>", s.print())).collect::<String>()
1146 fn print(self, f: &mut Buffer) {
1150 <span class='out-of-band'>\
1151 <span id='render-detail'>\
1152 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
1153 [<span class='inner'>−</span>]\
1157 <span class='in-band'>List of all items</span>\
1160 print_entries(f, &self.structs, "Structs", "structs");
1161 print_entries(f, &self.enums, "Enums", "enums");
1162 print_entries(f, &self.unions, "Unions", "unions");
1163 print_entries(f, &self.primitives, "Primitives", "primitives");
1164 print_entries(f, &self.traits, "Traits", "traits");
1165 print_entries(f, &self.macros, "Macros", "macros");
1166 print_entries(f, &self.attributes, "Attribute Macros", "attributes");
1167 print_entries(f, &self.derives, "Derive Macros", "derives");
1168 print_entries(f, &self.functions, "Functions", "functions");
1169 print_entries(f, &self.typedefs, "Typedefs", "typedefs");
1170 print_entries(f, &self.trait_aliases, "Trait Aliases", "trait-aliases");
1171 print_entries(f, &self.opaque_tys, "Opaque Types", "opaque-types");
1172 print_entries(f, &self.statics, "Statics", "statics");
1173 print_entries(f, &self.constants, "Constants", "constants")
1179 Section { description: &'static str, sub_settings: Vec<Setting> },
1180 Entry { js_data_name: &'static str, description: &'static str, default_value: bool },
1184 fn display(&self) -> String {
1186 Setting::Section { ref description, ref sub_settings } => format!(
1187 "<div class='setting-line'>\
1188 <div class='title'>{}</div>\
1189 <div class='sub-settings'>{}</div>
1192 sub_settings.iter().map(|s| s.display()).collect::<String>()
1194 Setting::Entry { ref js_data_name, ref description, ref default_value } => format!(
1195 "<div class='setting-line'>\
1196 <label class='toggle'>\
1197 <input type='checkbox' id='{}' {}>\
1198 <span class='slider'></span>\
1203 if *default_value { " checked" } else { "" },
1210 impl From<(&'static str, &'static str, bool)> for Setting {
1211 fn from(values: (&'static str, &'static str, bool)) -> Setting {
1212 Setting::Entry { js_data_name: values.0, description: values.1, default_value: values.2 }
1216 impl<T: Into<Setting>> From<(&'static str, Vec<T>)> for Setting {
1217 fn from(values: (&'static str, Vec<T>)) -> Setting {
1219 description: values.0,
1220 sub_settings: values.1.into_iter().map(|v| v.into()).collect::<Vec<_>>(),
1225 fn settings(root_path: &str, suffix: &str) -> String {
1226 // (id, explanation, default value)
1227 let settings: &[Setting] = &[
1229 "Auto-hide item declarations",
1231 ("auto-hide-struct", "Auto-hide structs declaration", true),
1232 ("auto-hide-enum", "Auto-hide enums declaration", false),
1233 ("auto-hide-union", "Auto-hide unions declaration", true),
1234 ("auto-hide-trait", "Auto-hide traits declaration", true),
1235 ("auto-hide-macro", "Auto-hide macros declaration", false),
1239 ("auto-hide-attributes", "Auto-hide item attributes.", true).into(),
1240 ("auto-hide-method-docs", "Auto-hide item methods' documentation", false).into(),
1241 ("auto-hide-trait-implementations", "Auto-hide trait implementations documentation", true)
1243 ("go-to-only-result", "Directly go to item in search if there is only one result", false)
1245 ("line-numbers", "Show line numbers on code examples", false).into(),
1246 ("disable-shortcuts", "Disable keyboard shortcuts", false).into(),
1250 <span class='in-band'>Rustdoc settings</span>\
1252 <div class='settings'>{}</div>\
1253 <script src='{}settings{}.js'></script>",
1254 settings.iter().map(|s| s.display()).collect::<String>(),
1261 fn derive_id(&self, id: String) -> String {
1262 let mut map = self.id_map.borrow_mut();
1266 /// String representation of how to get back to the root path of the 'doc/'
1267 /// folder in terms of a relative URL.
1268 fn root_path(&self) -> String {
1269 "../".repeat(self.current.len())
1272 /// Main method for rendering a crate.
1274 /// This currently isn't parallelized, but it'd be pretty easy to add
1275 /// parallelization to this function.
1276 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1277 let mut item = match krate.module.take() {
1279 None => return Ok(()),
1281 let final_file = self.dst.join(&krate.name).join("all.html");
1282 let settings_file = self.dst.join("settings.html");
1284 let crate_name = krate.name.clone();
1285 item.name = Some(krate.name);
1287 let mut all = AllTypes::new();
1290 // Render the crate documentation
1291 let mut work = vec![(self.clone(), item)];
1293 while let Some((mut cx, item)) = work.pop() {
1294 cx.item(item, &mut all, |cx, item| work.push((cx.clone(), item)))?
1298 let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
1299 if !root_path.ends_with('/') {
1300 root_path.push('/');
1302 let mut page = layout::Page {
1303 title: "List of all items in this crate",
1306 static_root_path: self.shared.static_root_path.as_deref(),
1307 description: "List of all items in this crate",
1308 keywords: BASIC_KEYWORDS,
1309 resource_suffix: &self.shared.resource_suffix,
1311 static_extra_scripts: &[],
1313 let sidebar = if let Some(ref version) = self.cache.crate_version {
1315 "<p class='location'>Crate {}</p>\
1316 <div class='block version'>\
1319 <a id='all-types' href='index.html'><p>Back to index</p></a>",
1325 let v = layout::render(
1326 &self.shared.layout,
1329 |buf: &mut Buffer| all.print(buf),
1330 &self.shared.themes,
1332 self.shared.fs.write(&final_file, v.as_bytes())?;
1334 // Generating settings page.
1335 page.title = "Rustdoc settings";
1336 page.description = "Settings of Rustdoc";
1337 page.root_path = "./";
1339 let mut themes = self.shared.themes.clone();
1340 let sidebar = "<p class='location'>Settings</p><div class='sidebar-elems'></div>";
1341 themes.push(PathBuf::from("settings.css"));
1342 let v = layout::render(
1343 &self.shared.layout,
1347 self.shared.static_root_path.as_deref().unwrap_or("./"),
1348 &self.shared.resource_suffix,
1352 self.shared.fs.write(&settings_file, v.as_bytes())?;
1357 fn render_item(&self, it: &clean::Item, pushname: bool) -> String {
1358 // A little unfortunate that this is done like this, but it sure
1359 // does make formatting *a lot* nicer.
1360 CURRENT_DEPTH.with(|slot| {
1361 slot.set(self.current.len());
1364 let mut title = if it.is_primitive() || it.is_keyword() {
1365 // No need to include the namespace for primitive types and keywords
1368 self.current.join("::")
1371 if !title.is_empty() {
1372 title.push_str("::");
1374 title.push_str(it.name.as_ref().unwrap());
1376 title.push_str(" - Rust");
1377 let tyname = it.type_();
1378 let desc = if it.is_crate() {
1379 format!("API documentation for the Rust `{}` crate.", self.shared.layout.krate)
1382 "API documentation for the Rust `{}` {} in crate `{}`.",
1383 it.name.as_ref().unwrap(),
1385 self.shared.layout.krate
1388 let keywords = make_item_keywords(it);
1389 let page = layout::Page {
1390 css_class: tyname.as_str(),
1391 root_path: &self.root_path(),
1392 static_root_path: self.shared.static_root_path.as_deref(),
1395 keywords: &keywords,
1396 resource_suffix: &self.shared.resource_suffix,
1398 static_extra_scripts: &[],
1402 self.id_map.borrow_mut().reset();
1403 self.id_map.borrow_mut().populate(initial_ids());
1406 if !self.render_redirect_pages {
1408 &self.shared.layout,
1410 |buf: &mut _| print_sidebar(self, it, buf),
1411 |buf: &mut _| print_item(self, it, buf),
1412 &self.shared.themes,
1415 let mut url = self.root_path();
1416 if let Some(&(ref names, ty)) = self.cache.paths.get(&it.def_id) {
1417 for name in &names[..names.len() - 1] {
1421 url.push_str(&item_path(ty, names.last().unwrap()));
1422 layout::redirect(&url)
1429 /// Non-parallelized version of rendering an item. This will take the input
1430 /// item, render its contents, and then invoke the specified closure with
1431 /// all sub-items which need to be rendered.
1433 /// The rendering driver uses this closure to queue up more work.
1434 fn item<F>(&mut self, item: clean::Item, all: &mut AllTypes, mut f: F) -> Result<(), Error>
1436 F: FnMut(&mut Context, clean::Item),
1438 // Stripped modules survive the rustdoc passes (i.e., `strip-private`)
1439 // if they contain impls for public types. These modules can also
1440 // contain items such as publicly re-exported structures.
1442 // External crates will provide links to these structures, so
1443 // these modules are recursed into, but not rendered normally
1444 // (a flag on the context).
1445 if !self.render_redirect_pages {
1446 self.render_redirect_pages = item.is_stripped();
1450 // modules are special because they add a namespace. We also need to
1451 // recurse into the items of the module as well.
1452 let name = item.name.as_ref().unwrap().to_string();
1453 let scx = &self.shared;
1454 if name.is_empty() {
1455 panic!("Unexpected empty destination: {:?}", self.current);
1457 let prev = self.dst.clone();
1458 self.dst.push(&name);
1459 self.current.push(name);
1461 info!("Recursing into {}", self.dst.display());
1463 let buf = self.render_item(&item, false);
1464 // buf will be empty if the module is stripped and there is no redirect for it
1465 if !buf.is_empty() {
1466 self.shared.ensure_dir(&self.dst)?;
1467 let joint_dst = self.dst.join("index.html");
1468 scx.fs.write(&joint_dst, buf.as_bytes())?;
1471 let m = match item.inner {
1472 clean::StrippedItem(box clean::ModuleItem(m)) | clean::ModuleItem(m) => m,
1473 _ => unreachable!(),
1476 // Render sidebar-items.js used throughout this module.
1477 if !self.render_redirect_pages {
1478 let items = self.build_sidebar_items(&m);
1479 let js_dst = self.dst.join("sidebar-items.js");
1480 let v = format!("initSidebarItems({});", serde_json::to_string(&items).unwrap());
1481 scx.fs.write(&js_dst, &v)?;
1484 for item in m.items {
1488 info!("Recursed; leaving {}", self.dst.display());
1490 // Go back to where we were at
1492 self.current.pop().unwrap();
1493 } else if item.name.is_some() {
1494 let buf = self.render_item(&item, true);
1495 // buf will be empty if the item is stripped and there is no redirect for it
1496 if !buf.is_empty() {
1497 let name = item.name.as_ref().unwrap();
1498 let item_type = item.type_();
1499 let file_name = &item_path(item_type, name);
1500 self.shared.ensure_dir(&self.dst)?;
1501 let joint_dst = self.dst.join(file_name);
1502 self.shared.fs.write(&joint_dst, buf.as_bytes())?;
1504 if !self.render_redirect_pages {
1505 all.append(full_path(self, &item), &item_type);
1507 if self.shared.generate_redirect_pages {
1508 // Redirect from a sane URL using the namespace to Rustdoc's
1509 // URL for the page.
1510 let redir_name = format!("{}.{}.html", name, item_type.name_space());
1511 let redir_dst = self.dst.join(redir_name);
1512 let v = layout::redirect(file_name);
1513 self.shared.fs.write(&redir_dst, v.as_bytes())?;
1515 // If the item is a macro, redirect from the old macro URL (with !)
1516 // to the new one (without).
1517 if item_type == ItemType::Macro {
1518 let redir_name = format!("{}.{}!.html", item_type, name);
1519 let redir_dst = self.dst.join(redir_name);
1520 let v = layout::redirect(file_name);
1521 self.shared.fs.write(&redir_dst, v.as_bytes())?;
1528 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
1529 // BTreeMap instead of HashMap to get a sorted output
1530 let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
1531 for item in &m.items {
1532 if item.is_stripped() {
1536 let short = item.type_();
1537 let myname = match item.name {
1539 Some(ref s) => s.to_string(),
1541 let short = short.to_string();
1544 .push((myname, Some(plain_summary_line(item.doc_value()))));
1547 if self.shared.sort_modules_alphabetically {
1548 for (_, items) in &mut map {
1557 /// Generates a url appropriate for an `href` attribute back to the source of
1560 /// The url generated, when clicked, will redirect the browser back to the
1561 /// original source code.
1563 /// If `None` is returned, then a source link couldn't be generated. This
1564 /// may happen, for example, with externally inlined items where the source
1565 /// of their crate documentation isn't known.
1566 fn src_href(&self, item: &clean::Item) -> Option<String> {
1567 let mut root = self.root_path();
1569 let mut path = String::new();
1571 // We can safely ignore macros from other libraries
1572 let file = match item.source.filename {
1573 FileName::Real(ref path) => path,
1577 let (krate, path) = if item.def_id.is_local() {
1578 if let Some(path) = self.shared.local_sources.get(file) {
1579 (&self.shared.layout.krate, path)
1584 let (krate, src_root) = match *self.cache.extern_locations.get(&item.def_id.krate)? {
1585 (ref name, ref src, Local) => (name, src),
1586 (ref name, ref src, Remote(ref s)) => {
1587 root = s.to_string();
1590 (_, _, Unknown) => return None,
1593 sources::clean_path(&src_root, file, false, |component| {
1594 path.push_str(&component.to_string_lossy());
1597 let mut fname = file.file_name().expect("source has no filename").to_os_string();
1598 fname.push(".html");
1599 path.push_str(&fname.to_string_lossy());
1603 let lines = if item.source.loline == item.source.hiline {
1604 item.source.loline.to_string()
1606 format!("{}-{}", item.source.loline, item.source.hiline)
1609 "{root}src/{krate}/{path}#{lines}",
1610 root = Escape(&root),
1618 fn wrap_into_docblock<F>(w: &mut Buffer, f: F)
1620 F: FnOnce(&mut Buffer),
1622 write!(w, "<div class=\"docblock type-decl hidden-by-usual-hider\">");
1627 fn print_item(cx: &Context, item: &clean::Item, buf: &mut Buffer) {
1628 debug_assert!(!item.is_stripped());
1629 // Write the breadcrumb trail header for the top
1630 write!(buf, "<h1 class='fqn'><span class='out-of-band'>");
1631 if let Some(version) = item.stable_since() {
1634 "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
1640 "<span id='render-detail'>\
1641 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" \
1642 title=\"collapse all docs\">\
1643 [<span class='inner'>−</span>]\
1650 // When this item is part of a `pub use` in a downstream crate, the
1651 // [src] link in the downstream documentation will actually come back to
1652 // this page, and this link will be auto-clicked. The `id` attribute is
1653 // used to find the link to auto-click.
1654 if cx.shared.include_sources && !item.is_primitive() {
1655 if let Some(l) = cx.src_href(item) {
1656 write!(buf, "<a class='srclink' href='{}' title='{}'>[src]</a>", l, "goto source code");
1660 write!(buf, "</span>"); // out-of-band
1661 write!(buf, "<span class='in-band'>");
1662 let name = match item.inner {
1663 clean::ModuleItem(ref m) => {
1670 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) => "Function ",
1671 clean::TraitItem(..) => "Trait ",
1672 clean::StructItem(..) => "Struct ",
1673 clean::UnionItem(..) => "Union ",
1674 clean::EnumItem(..) => "Enum ",
1675 clean::TypedefItem(..) => "Type Definition ",
1676 clean::MacroItem(..) => "Macro ",
1677 clean::ProcMacroItem(ref mac) => match mac.kind {
1678 MacroKind::Bang => "Macro ",
1679 MacroKind::Attr => "Attribute Macro ",
1680 MacroKind::Derive => "Derive Macro ",
1682 clean::PrimitiveItem(..) => "Primitive Type ",
1683 clean::StaticItem(..) | clean::ForeignStaticItem(..) => "Static ",
1684 clean::ConstantItem(..) => "Constant ",
1685 clean::ForeignTypeItem => "Foreign Type ",
1686 clean::KeywordItem(..) => "Keyword ",
1687 clean::OpaqueTyItem(..) => "Opaque Type ",
1688 clean::TraitAliasItem(..) => "Trait Alias ",
1690 // We don't generate pages for any other type.
1694 buf.write_str(name);
1695 if !item.is_primitive() && !item.is_keyword() {
1696 let cur = &cx.current;
1697 let amt = if item.is_mod() { cur.len() - 1 } else { cur.len() };
1698 for (i, component) in cur.iter().enumerate().take(amt) {
1701 "<a href='{}index.html'>{}</a>::<wbr>",
1702 "../".repeat(cur.len() - i - 1),
1707 write!(buf, "<a class=\"{}\" href=''>{}</a>", item.type_(), item.name.as_ref().unwrap());
1709 write!(buf, "</span></h1>"); // in-band
1712 clean::ModuleItem(ref m) => item_module(buf, cx, item, &m.items),
1713 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) => {
1714 item_function(buf, cx, item, f)
1716 clean::TraitItem(ref t) => item_trait(buf, cx, item, t),
1717 clean::StructItem(ref s) => item_struct(buf, cx, item, s),
1718 clean::UnionItem(ref s) => item_union(buf, cx, item, s),
1719 clean::EnumItem(ref e) => item_enum(buf, cx, item, e),
1720 clean::TypedefItem(ref t, _) => item_typedef(buf, cx, item, t),
1721 clean::MacroItem(ref m) => item_macro(buf, cx, item, m),
1722 clean::ProcMacroItem(ref m) => item_proc_macro(buf, cx, item, m),
1723 clean::PrimitiveItem(_) => item_primitive(buf, cx, item),
1724 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) => item_static(buf, cx, item, i),
1725 clean::ConstantItem(ref c) => item_constant(buf, cx, item, c),
1726 clean::ForeignTypeItem => item_foreign_type(buf, cx, item),
1727 clean::KeywordItem(_) => item_keyword(buf, cx, item),
1728 clean::OpaqueTyItem(ref e, _) => item_opaque_ty(buf, cx, item, e),
1729 clean::TraitAliasItem(ref ta) => item_trait_alias(buf, cx, item, ta),
1731 // We don't generate pages for any other type.
1737 fn item_path(ty: ItemType, name: &str) -> String {
1739 ItemType::Module => format!("{}index.html", ensure_trailing_slash(name)),
1740 _ => format!("{}.{}.html", ty, name),
1744 fn full_path(cx: &Context, item: &clean::Item) -> String {
1745 let mut s = cx.current.join("::");
1747 s.push_str(item.name.as_ref().unwrap());
1752 fn plain_summary_line(s: Option<&str>) -> String {
1753 let s = s.unwrap_or("");
1754 // This essentially gets the first paragraph of text in one line.
1757 .skip_while(|line| line.chars().all(|c| c.is_whitespace()))
1758 .take_while(|line| line.chars().any(|c| !c.is_whitespace()))
1759 .fold(String::new(), |mut acc, line| {
1764 // remove final whitespace
1766 markdown::plain_summary_line(&line[..])
1769 fn shorten(s: String) -> String {
1770 if s.chars().count() > 60 {
1775 // + 1 for the added character after the word.
1776 len += p.chars().count() + 1;
1779 .collect::<Vec<_>>()
1788 fn document(w: &mut Buffer, cx: &Context, item: &clean::Item) {
1789 if let Some(ref name) = item.name {
1790 info!("Documenting {}", name);
1792 document_stability(w, cx, item, false);
1793 document_full(w, item, cx, "", false);
1796 /// Render md_text as markdown.
1801 links: Vec<(String, String)>,
1805 let mut ids = cx.id_map.borrow_mut();
1808 "<div class='docblock{}'>{}{}</div>",
1809 if is_hidden { " hidden" } else { "" },
1817 &cx.shared.playground
1827 link: AssocItemLink<'_>,
1831 if let Some(s) = item.doc_value() {
1832 let markdown = if s.contains('\n') {
1834 "{} [Read more]({})",
1835 &plain_summary_line(Some(s)),
1836 naive_assoc_href(item, link)
1839 plain_summary_line(Some(s))
1841 render_markdown(w, cx, &markdown, item.links(), prefix, is_hidden);
1842 } else if !prefix.is_empty() {
1845 "<div class='docblock{}'>{}</div>",
1846 if is_hidden { " hidden" } else { "" },
1852 fn document_full(w: &mut Buffer, item: &clean::Item, cx: &Context, prefix: &str, is_hidden: bool) {
1853 if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
1854 debug!("Doc block: =====\n{}\n=====", s);
1855 render_markdown(w, cx, &*s, item.links(), prefix, is_hidden);
1856 } else if !prefix.is_empty() {
1859 "<div class='docblock{}'>{}</div>",
1860 if is_hidden { " hidden" } else { "" },
1866 fn document_stability(w: &mut Buffer, cx: &Context, item: &clean::Item, is_hidden: bool) {
1867 let stabilities = short_stability(item, cx);
1868 if !stabilities.is_empty() {
1869 write!(w, "<div class='stability{}'>", if is_hidden { " hidden" } else { "" });
1870 for stability in stabilities {
1871 write!(w, "{}", stability);
1873 write!(w, "</div>");
1877 fn document_non_exhaustive_header(item: &clean::Item) -> &str {
1878 if item.is_non_exhaustive() { " (Non-exhaustive)" } else { "" }
1881 fn document_non_exhaustive(w: &mut Buffer, item: &clean::Item) {
1882 if item.is_non_exhaustive() {
1883 write!(w, "<div class='docblock non-exhaustive non-exhaustive-{}'>", {
1884 if item.is_struct() {
1886 } else if item.is_enum() {
1888 } else if item.is_variant() {
1895 if item.is_struct() {
1898 "Non-exhaustive structs could have additional fields added in future. \
1899 Therefore, non-exhaustive structs cannot be constructed in external crates \
1900 using the traditional <code>Struct {{ .. }}</code> syntax; cannot be \
1901 matched against without a wildcard <code>..</code>; and \
1902 struct update syntax will not work."
1904 } else if item.is_enum() {
1907 "Non-exhaustive enums could have additional variants added in future. \
1908 Therefore, when matching against variants of non-exhaustive enums, an \
1909 extra wildcard arm must be added to account for any future variants."
1911 } else if item.is_variant() {
1914 "Non-exhaustive enum variants could have additional fields added in future. \
1915 Therefore, non-exhaustive enum variants cannot be constructed in external \
1916 crates and cannot be matched against."
1921 "This type will require a wildcard arm in any match statements or \
1926 write!(w, "</div>");
1930 fn name_key(name: &str) -> (&str, u64, usize) {
1931 let end = name.bytes().rposition(|b| b.is_ascii_digit()).map_or(name.len(), |i| i + 1);
1933 // find number at end
1934 let split = name[0..end].bytes().rposition(|b| !b.is_ascii_digit()).map_or(0, |i| i + 1);
1936 // count leading zeroes
1938 name[split..end].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
1940 // sort leading zeroes last
1941 let num_zeroes = after_zeroes - split;
1943 match name[split..end].parse() {
1944 Ok(n) => (&name[..split], n, num_zeroes),
1945 Err(_) => (name, 0, num_zeroes),
1949 fn item_module(w: &mut Buffer, cx: &Context, item: &clean::Item, items: &[clean::Item]) {
1950 document(w, cx, item);
1952 let mut indices = (0..items.len()).filter(|i| !items[*i].is_stripped()).collect::<Vec<usize>>();
1954 // the order of item types in the listing
1955 fn reorder(ty: ItemType) -> u8 {
1957 ItemType::ExternCrate => 0,
1958 ItemType::Import => 1,
1959 ItemType::Primitive => 2,
1960 ItemType::Module => 3,
1961 ItemType::Macro => 4,
1962 ItemType::Struct => 5,
1963 ItemType::Enum => 6,
1964 ItemType::Constant => 7,
1965 ItemType::Static => 8,
1966 ItemType::Trait => 9,
1967 ItemType::Function => 10,
1968 ItemType::Typedef => 12,
1969 ItemType::Union => 13,
1974 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
1975 let ty1 = i1.type_();
1976 let ty2 = i2.type_();
1978 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2));
1980 let s1 = i1.stability.as_ref().map(|s| s.level);
1981 let s2 = i2.stability.as_ref().map(|s| s.level);
1983 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
1984 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
1987 let lhs = i1.name.as_ref().map_or("", |s| &**s);
1988 let rhs = i2.name.as_ref().map_or("", |s| &**s);
1989 name_key(lhs).cmp(&name_key(rhs))
1992 if cx.shared.sort_modules_alphabetically {
1993 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
1995 // This call is to remove re-export duplicates in cases such as:
2000 // pub trait Double { fn foo(); }
2004 // pub use foo::bar::*;
2008 // `Double` will appear twice in the generated docs.
2010 // FIXME: This code is quite ugly and could be improved. Small issue: DefId
2011 // can be identical even if the elements are different (mostly in imports).
2012 // So in case this is an import, we keep everything by adding a "unique id"
2013 // (which is the position in the vector).
2014 indices.dedup_by_key(|i| {
2017 if items[*i].name.as_ref().is_some() { Some(full_path(cx, &items[*i])) } else { None },
2019 if items[*i].is_import() { *i } else { 0 },
2023 debug!("{:?}", indices);
2024 let mut curty = None;
2025 for &idx in &indices {
2026 let myitem = &items[idx];
2027 if myitem.is_stripped() {
2031 let myty = Some(myitem.type_());
2032 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
2033 // Put `extern crate` and `use` re-exports in the same section.
2035 } else if myty != curty {
2036 if curty.is_some() {
2037 write!(w, "</table>");
2040 let (short, name) = item_ty_to_strs(&myty.unwrap());
2043 "<h2 id='{id}' class='section-header'>\
2044 <a href=\"#{id}\">{name}</a></h2>\n<table>",
2045 id = cx.derive_id(short.to_owned()),
2050 match myitem.inner {
2051 clean::ExternCrateItem(ref name, ref src) => {
2052 use crate::html::format::anchor;
2055 Some(ref src) => write!(
2057 "<tr><td><code>{}extern crate {} as {};",
2058 myitem.visibility.print_with_space(),
2059 anchor(myitem.def_id, src),
2064 "<tr><td><code>{}extern crate {};",
2065 myitem.visibility.print_with_space(),
2066 anchor(myitem.def_id, name)
2069 write!(w, "</code></td></tr>");
2072 clean::ImportItem(ref import) => {
2075 "<tr><td><code>{}{}</code></td></tr>",
2076 myitem.visibility.print_with_space(),
2082 if myitem.name.is_none() {
2086 let unsafety_flag = match myitem.inner {
2087 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
2088 if func.header.unsafety == hir::Unsafety::Unsafe =>
2090 "<a title='unsafe function' href='#'><sup>⚠</sup></a>"
2095 let stab = myitem.stability_class();
2096 let add = if stab.is_some() { " " } else { "" };
2098 let doc_value = myitem.doc_value().unwrap_or("");
2102 <tr class='{stab}{add}module-item'>\
2103 <td><a class=\"{class}\" href=\"{href}\" \
2104 title='{title}'>{name}</a>{unsafety_flag}</td>\
2105 <td class='docblock-short'>{stab_tags}{docs}</td>\
2107 name = *myitem.name.as_ref().unwrap(),
2108 stab_tags = stability_tags(myitem),
2109 docs = MarkdownSummaryLine(doc_value, &myitem.links()).to_string(),
2110 class = myitem.type_(),
2112 stab = stab.unwrap_or_else(|| String::new()),
2113 unsafety_flag = unsafety_flag,
2114 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
2115 title = [full_path(cx, myitem), myitem.type_().to_string()]
2117 .filter_map(|s| if !s.is_empty() { Some(s.as_str()) } else { None })
2118 .collect::<Vec<_>>()
2125 if curty.is_some() {
2126 write!(w, "</table>");
2130 /// Render the stability and deprecation tags that are displayed in the item's summary at the
2132 fn stability_tags(item: &clean::Item) -> String {
2133 let mut tags = String::new();
2135 fn tag_html(class: &str, contents: &str) -> String {
2136 format!(r#"<span class="stab {}">{}</span>"#, class, contents)
2139 // The trailing space after each tag is to space it properly against the rest of the docs.
2140 if item.deprecation().is_some() {
2141 let mut message = "Deprecated";
2142 if let Some(ref stab) = item.stability {
2143 if let Some(ref depr) = stab.deprecation {
2144 if let Some(ref since) = depr.since {
2145 if !stability::deprecation_in_effect(&since) {
2146 message = "Deprecation planned";
2151 tags += &tag_html("deprecated", message);
2154 if let Some(stab) = item.stability.as_ref().filter(|s| s.level == stability::Unstable) {
2155 if stab.feature.as_deref() == Some("rustc_private") {
2156 tags += &tag_html("internal", "Internal");
2158 tags += &tag_html("unstable", "Experimental");
2162 if let Some(ref cfg) = item.attrs.cfg {
2163 tags += &tag_html("portability", &cfg.render_short_html());
2169 /// Render the stability and/or deprecation warning that is displayed at the top of the item's
2171 fn short_stability(item: &clean::Item, cx: &Context) -> Vec<String> {
2172 let mut stability = vec![];
2173 let error_codes = cx.shared.codes;
2175 if let Some(Deprecation { note, since }) = &item.deprecation() {
2176 // We display deprecation messages for #[deprecated] and #[rustc_deprecated]
2177 // but only display the future-deprecation messages for #[rustc_deprecated].
2178 let mut message = if let Some(since) = since {
2179 format!("Deprecated since {}", Escape(since))
2181 String::from("Deprecated")
2183 if let Some(ref stab) = item.stability {
2184 if let Some(ref depr) = stab.deprecation {
2185 if let Some(ref since) = depr.since {
2186 if !stability::deprecation_in_effect(&since) {
2187 message = format!("Deprecating in {}", Escape(&since));
2193 if let Some(note) = note {
2194 let mut ids = cx.id_map.borrow_mut();
2195 let html = MarkdownHtml(
2200 &cx.shared.playground,
2202 message.push_str(&format!(": {}", html.to_string()));
2204 stability.push(format!("<div class='stab deprecated'>{}</div>", message));
2207 if let Some(stab) = item.stability.as_ref().filter(|stab| stab.level == stability::Unstable) {
2208 let is_rustc_private = stab.feature.as_deref() == Some("rustc_private");
2210 let mut message = if is_rustc_private {
2211 "<span class='emoji'>⚙️</span> This is an internal compiler API."
2213 "<span class='emoji'>🔬</span> This is a nightly-only experimental API."
2217 if let Some(feature) = stab.feature.as_deref() {
2218 let mut feature = format!("<code>{}</code>", Escape(&feature));
2219 if let (Some(url), Some(issue)) = (&cx.shared.issue_tracker_base_url, stab.issue) {
2220 feature.push_str(&format!(
2221 " <a href=\"{url}{issue}\">#{issue}</a>",
2227 message.push_str(&format!(" ({})", feature));
2230 if let Some(unstable_reason) = &stab.unstable_reason {
2231 // Provide a more informative message than the compiler help.
2232 let unstable_reason = if is_rustc_private {
2233 "This crate is being loaded from the sysroot, a permanently unstable location \
2234 for private compiler dependencies. It is not intended for general use. Prefer \
2235 using a public version of this crate from \
2236 [crates.io](https://crates.io) via [`Cargo.toml`]\
2237 (https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html)."
2242 let mut ids = cx.id_map.borrow_mut();
2244 "<details><summary>{}</summary>{}</details>",
2251 &cx.shared.playground,
2257 let class = if is_rustc_private { "internal" } else { "unstable" };
2258 stability.push(format!("<div class='stab {}'>{}</div>", class, message));
2261 if let Some(ref cfg) = item.attrs.cfg {
2262 stability.push(format!("<div class='stab portability'>{}</div>", cfg.render_long_html()));
2268 fn item_constant(w: &mut Buffer, cx: &Context, it: &clean::Item, c: &clean::Constant) {
2269 write!(w, "<pre class='rust const'>");
2270 render_attributes(w, it, false);
2276 vis = it.visibility.print_with_space(),
2277 name = it.name.as_ref().unwrap(),
2278 typ = c.type_.print(),
2281 if c.value.is_some() || c.is_literal {
2282 write!(w, " = {expr};", expr = Escape(&c.expr));
2287 if let Some(value) = &c.value {
2289 let value_lowercase = value.to_lowercase();
2290 let expr_lowercase = c.expr.to_lowercase();
2292 if value_lowercase != expr_lowercase
2293 && value_lowercase.trim_end_matches("i32") != expr_lowercase
2295 write!(w, " // {value}", value = Escape(value));
2300 write!(w, "</pre>");
2304 fn item_static(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Static) {
2305 write!(w, "<pre class='rust static'>");
2306 render_attributes(w, it, false);
2309 "{vis}static {mutability}\
2310 {name}: {typ}</pre>",
2311 vis = it.visibility.print_with_space(),
2312 mutability = s.mutability.print_with_space(),
2313 name = it.name.as_ref().unwrap(),
2314 typ = s.type_.print()
2319 fn item_function(w: &mut Buffer, cx: &Context, it: &clean::Item, f: &clean::Function) {
2320 let header_len = format!(
2321 "{}{}{}{}{:#}fn {}{:#}",
2322 it.visibility.print_with_space(),
2323 f.header.constness.print_with_space(),
2324 f.header.unsafety.print_with_space(),
2325 f.header.asyncness.print_with_space(),
2326 print_abi_with_space(f.header.abi),
2327 it.name.as_ref().unwrap(),
2331 write!(w, "{}<pre class='rust fn'>", render_spotlight_traits(it));
2332 render_attributes(w, it, false);
2335 "{vis}{constness}{unsafety}{asyncness}{abi}fn \
2336 {name}{generics}{decl}{where_clause}</pre>",
2337 vis = it.visibility.print_with_space(),
2338 constness = f.header.constness.print_with_space(),
2339 unsafety = f.header.unsafety.print_with_space(),
2340 asyncness = f.header.asyncness.print_with_space(),
2341 abi = print_abi_with_space(f.header.abi),
2342 name = it.name.as_ref().unwrap(),
2343 generics = f.generics.print(),
2344 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2345 decl = Function { decl: &f.decl, header_len, indent: 0, asyncness: f.header.asyncness }
2351 fn render_implementor(
2355 implementor_dups: &FxHashMap<&str, (DefId, bool)>,
2357 // If there's already another implementor that has the same abbridged name, use the
2358 // full path, for example in `std::iter::ExactSizeIterator`
2359 let use_absolute = match implementor.inner_impl().for_ {
2360 clean::ResolvedPath { ref path, is_generic: false, .. }
2361 | clean::BorrowedRef {
2362 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2364 } => implementor_dups[path.last_name()].1,
2371 AssocItemLink::Anchor(None),
2373 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(),
2402 .collect::<Vec<_>>();
2404 w.write_str(&impls.join(""));
2407 fn bounds(t_bounds: &[clean::GenericBound], trait_alias: bool) -> String {
2408 let mut bounds = String::new();
2409 if !t_bounds.is_empty() {
2411 bounds.push_str(": ");
2413 for (i, p) in t_bounds.iter().enumerate() {
2415 bounds.push_str(" + ");
2417 bounds.push_str(&p.print().to_string());
2423 fn compare_impl<'a, 'b>(lhs: &'a &&Impl, rhs: &'b &&Impl) -> Ordering {
2424 let lhs = format!("{}", lhs.inner_impl().print());
2425 let rhs = format!("{}", rhs.inner_impl().print());
2427 // lhs and rhs are formatted as HTML, which may be unnecessary
2428 name_key(&lhs).cmp(&name_key(&rhs))
2431 fn item_trait(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Trait) {
2432 let bounds = bounds(&t.bounds, false);
2433 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2434 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2435 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2436 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2438 // Output the trait definition
2439 wrap_into_docblock(w, |w| {
2440 write!(w, "<pre class='rust trait'>");
2441 render_attributes(w, it, true);
2444 "{}{}{}trait {}{}{}",
2445 it.visibility.print_with_space(),
2446 t.unsafety.print_with_space(),
2447 if t.is_auto { "auto " } else { "" },
2448 it.name.as_ref().unwrap(),
2453 if !t.generics.where_predicates.is_empty() {
2454 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true });
2459 if t.items.is_empty() {
2462 // FIXME: we should be using a derived_id for the Anchors here
2465 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait);
2468 if !types.is_empty() && !consts.is_empty() {
2472 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait);
2475 if !consts.is_empty() && !required.is_empty() {
2478 for (pos, m) in required.iter().enumerate() {
2479 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait);
2482 if pos < required.len() - 1 {
2483 write!(w, "<div class='item-spacer'></div>");
2486 if !required.is_empty() && !provided.is_empty() {
2489 for (pos, m) in provided.iter().enumerate() {
2490 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait);
2492 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2493 write!(w, ",\n {{ ... }}\n");
2496 write!(w, " {{ ... }}\n");
2499 if pos < provided.len() - 1 {
2500 write!(w, "<div class='item-spacer'></div>");
2508 // Trait documentation
2509 document(w, cx, it);
2511 fn write_small_section_header(w: &mut Buffer, id: &str, title: &str, extra_content: &str) {
2515 <h2 id='{0}' class='small-section-header'>\
2516 {1}<a href='#{0}' class='anchor'></a>\
2518 id, title, extra_content
2522 fn write_loading_content(w: &mut Buffer, extra_content: &str) {
2523 write!(w, "{}<span class='loading-content'>Loading content...</span>", extra_content)
2526 fn trait_item(w: &mut Buffer, cx: &Context, m: &clean::Item, t: &clean::Item) {
2527 let name = m.name.as_ref().unwrap();
2528 let item_type = m.type_();
2529 let id = cx.derive_id(format!("{}.{}", item_type, name));
2530 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
2533 "<h3 id='{id}' class='method'>{extra}<code id='{ns_id}'>",
2534 extra = render_spotlight_traits(m),
2538 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl);
2539 write!(w, "</code>");
2540 render_stability_since(w, m, t);
2545 if !types.is_empty() {
2546 write_small_section_header(
2550 "<div class='methods'>",
2553 trait_item(w, cx, *t, it);
2555 write_loading_content(w, "</div>");
2558 if !consts.is_empty() {
2559 write_small_section_header(
2562 "Associated Constants",
2563 "<div class='methods'>",
2566 trait_item(w, cx, *t, it);
2568 write_loading_content(w, "</div>");
2571 // Output the documentation for each function individually
2572 if !required.is_empty() {
2573 write_small_section_header(
2577 "<div class='methods'>",
2579 for m in &required {
2580 trait_item(w, cx, *m, it);
2582 write_loading_content(w, "</div>");
2584 if !provided.is_empty() {
2585 write_small_section_header(
2589 "<div class='methods'>",
2591 for m in &provided {
2592 trait_item(w, cx, *m, it);
2594 write_loading_content(w, "</div>");
2597 // If there are methods directly on this trait object, render them here.
2598 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All);
2600 let mut synthetic_types = Vec::new();
2602 if let Some(implementors) = cx.cache.implementors.get(&it.def_id) {
2603 // The DefId is for the first Type found with that name. The bool is
2604 // if any Types with the same name but different DefId have been found.
2605 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap::default();
2606 for implementor in implementors {
2607 match implementor.inner_impl().for_ {
2608 clean::ResolvedPath { ref path, did, is_generic: false, .. }
2609 | clean::BorrowedRef {
2610 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2613 let &mut (prev_did, ref mut has_duplicates) =
2614 implementor_dups.entry(path.last_name()).or_insert((did, false));
2615 if prev_did != did {
2616 *has_duplicates = true;
2623 let (local, foreign) = implementors.iter().partition::<Vec<_>, _>(|i| {
2624 i.inner_impl().for_.def_id().map_or(true, |d| cx.cache.paths.contains_key(&d))
2627 let (mut synthetic, mut concrete): (Vec<&&Impl>, Vec<&&Impl>) =
2628 local.iter().partition(|i| i.inner_impl().synthetic);
2630 synthetic.sort_by(compare_impl);
2631 concrete.sort_by(compare_impl);
2633 if !foreign.is_empty() {
2634 write_small_section_header(w, "foreign-impls", "Implementations on Foreign Types", "");
2636 for implementor in foreign {
2637 let assoc_link = AssocItemLink::GotoSource(
2638 implementor.impl_item.def_id,
2639 &implementor.inner_impl().provided_trait_methods,
2647 implementor.impl_item.stable_since(),
2654 write_loading_content(w, "");
2657 write_small_section_header(
2661 "<div class='item-list' id='implementors-list'>",
2663 for implementor in concrete {
2664 render_implementor(cx, implementor, w, &implementor_dups);
2666 write_loading_content(w, "</div>");
2669 write_small_section_header(
2671 "synthetic-implementors",
2672 "Auto implementors",
2673 "<div class='item-list' id='synthetic-implementors-list'>",
2675 for implementor in synthetic {
2677 .extend(collect_paths_for_type(implementor.inner_impl().for_.clone()));
2678 render_implementor(cx, implementor, w, &implementor_dups);
2680 write_loading_content(w, "</div>");
2683 // even without any implementations to write in, we still want the heading and list, so the
2684 // implementors javascript file pulled in below has somewhere to write the impls into
2685 write_small_section_header(
2689 "<div class='item-list' id='implementors-list'>",
2691 write_loading_content(w, "</div>");
2694 write_small_section_header(
2696 "synthetic-implementors",
2697 "Auto implementors",
2698 "<div class='item-list' id='synthetic-implementors-list'>",
2700 write_loading_content(w, "</div>");
2705 r#"<script type="text/javascript">window.inlined_types=new Set({});</script>"#,
2706 serde_json::to_string(&synthetic_types).unwrap(),
2711 r#"<script type="text/javascript" async
2712 src="{root_path}/implementors/{path}/{ty}.{name}.js">
2714 root_path = vec![".."; cx.current.len()].join("/"),
2715 path = if it.def_id.is_local() {
2716 cx.current.join("/")
2718 let (ref path, _) = cx.cache.external_paths[&it.def_id];
2719 path[..path.len() - 1].join("/")
2722 name = *it.name.as_ref().unwrap()
2726 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink<'_>) -> String {
2727 use crate::html::item_type::ItemType::*;
2729 let name = it.name.as_ref().unwrap();
2730 let ty = match it.type_() {
2731 Typedef | AssocType => AssocType,
2735 let anchor = format!("#{}.{}", ty, name);
2737 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2738 AssocItemLink::Anchor(None) => anchor,
2739 AssocItemLink::GotoSource(did, _) => {
2740 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
2749 _default: Option<&String>,
2750 link: AssocItemLink<'_>,
2755 "{}{}const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
2757 it.visibility.print_with_space(),
2758 naive_assoc_href(it, link),
2759 it.name.as_ref().unwrap(),
2767 bounds: &[clean::GenericBound],
2768 default: Option<&clean::Type>,
2769 link: AssocItemLink<'_>,
2774 "{}type <a href='{}' class=\"type\">{}</a>",
2776 naive_assoc_href(it, link),
2777 it.name.as_ref().unwrap()
2779 if !bounds.is_empty() {
2780 write!(w, ": {}", print_generic_bounds(bounds))
2782 if let Some(default) = default {
2783 write!(w, " = {}", default.print())
2787 fn render_stability_since_raw(w: &mut Buffer, ver: Option<&str>, containing_ver: Option<&str>) {
2788 if let Some(v) = ver {
2789 if containing_ver != ver && v.len() > 0 {
2790 write!(w, "<span class='since' title='Stable since Rust version {0}'>{0}</span>", v)
2795 fn render_stability_since(w: &mut Buffer, item: &clean::Item, containing_item: &clean::Item) {
2796 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
2799 fn render_assoc_item(
2802 link: AssocItemLink<'_>,
2808 header: hir::FnHeader,
2809 g: &clean::Generics,
2811 link: AssocItemLink<'_>,
2814 let name = meth.name.as_ref().unwrap();
2815 let anchor = format!("#{}.{}", meth.type_(), name);
2816 let href = match link {
2817 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2818 AssocItemLink::Anchor(None) => anchor,
2819 AssocItemLink::GotoSource(did, provided_methods) => {
2820 // We're creating a link from an impl-item to the corresponding
2821 // trait-item and need to map the anchored type accordingly.
2822 let ty = if provided_methods.contains(name) {
2828 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
2831 let mut header_len = format!(
2832 "{}{}{}{}{}{:#}fn {}{:#}",
2833 meth.visibility.print_with_space(),
2834 header.constness.print_with_space(),
2835 header.unsafety.print_with_space(),
2836 header.asyncness.print_with_space(),
2837 print_default_space(meth.is_default()),
2838 print_abi_with_space(header.abi),
2843 let (indent, end_newline) = if parent == ItemType::Trait {
2849 render_attributes(w, meth, false);
2852 "{}{}{}{}{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
2853 {generics}{decl}{where_clause}",
2854 if parent == ItemType::Trait { " " } else { "" },
2855 meth.visibility.print_with_space(),
2856 header.constness.print_with_space(),
2857 header.unsafety.print_with_space(),
2858 header.asyncness.print_with_space(),
2859 print_default_space(meth.is_default()),
2860 print_abi_with_space(header.abi),
2863 generics = g.print(),
2864 decl = Function { decl: d, header_len, indent, asyncness: header.asyncness }.print(),
2865 where_clause = WhereClause { gens: g, indent, end_newline }
2869 clean::StrippedItem(..) => {}
2870 clean::TyMethodItem(ref m) => method(w, item, m.header, &m.generics, &m.decl, link, parent),
2871 clean::MethodItem(ref m) => method(w, item, m.header, &m.generics, &m.decl, link, parent),
2872 clean::AssocConstItem(ref ty, ref default) => assoc_const(
2878 if parent == ItemType::Trait { " " } else { "" },
2880 clean::AssocTypeItem(ref bounds, ref default) => assoc_type(
2886 if parent == ItemType::Trait { " " } else { "" },
2888 _ => panic!("render_assoc_item called on non-associated-item"),
2892 fn item_struct(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Struct) {
2893 wrap_into_docblock(w, |w| {
2894 write!(w, "<pre class='rust struct'>");
2895 render_attributes(w, it, true);
2896 render_struct(w, it, Some(&s.generics), s.struct_type, &s.fields, "", true);
2900 document(w, cx, it);
2904 .filter_map(|f| match f.inner {
2905 clean::StructFieldItem(ref ty) => Some((f, ty)),
2909 if let doctree::Plain = s.struct_type {
2910 if fields.peek().is_some() {
2913 "<h2 id='fields' class='fields small-section-header'>
2914 Fields{}<a href='#fields' class='anchor'></a></h2>",
2915 document_non_exhaustive_header(it)
2917 document_non_exhaustive(w, it);
2918 for (field, ty) in fields {
2919 let id = cx.derive_id(format!(
2921 ItemType::StructField,
2922 field.name.as_ref().unwrap()
2924 let ns_id = cx.derive_id(format!(
2926 field.name.as_ref().unwrap(),
2927 ItemType::StructField.name_space()
2931 "<span id=\"{id}\" class=\"{item_type} small-section-header\">\
2932 <a href=\"#{id}\" class=\"anchor field\"></a>\
2933 <code id=\"{ns_id}\">{name}: {ty}</code>\
2935 item_type = ItemType::StructField,
2938 name = field.name.as_ref().unwrap(),
2941 document(w, cx, field);
2945 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2948 fn item_union(w: &mut Buffer, cx: &Context, it: &clean::Item, s: &clean::Union) {
2949 wrap_into_docblock(w, |w| {
2950 write!(w, "<pre class='rust union'>");
2951 render_attributes(w, it, true);
2952 render_union(w, it, Some(&s.generics), &s.fields, "", true);
2956 document(w, cx, it);
2960 .filter_map(|f| match f.inner {
2961 clean::StructFieldItem(ref ty) => Some((f, ty)),
2965 if fields.peek().is_some() {
2968 "<h2 id='fields' class='fields small-section-header'>
2969 Fields<a href='#fields' class='anchor'></a></h2>"
2971 for (field, ty) in fields {
2972 let name = field.name.as_ref().expect("union field name");
2973 let id = format!("{}.{}", ItemType::StructField, name);
2976 "<span id=\"{id}\" class=\"{shortty} small-section-header\">\
2977 <a href=\"#{id}\" class=\"anchor field\"></a>\
2978 <code>{name}: {ty}</code>\
2982 shortty = ItemType::StructField,
2985 if let Some(stability_class) = field.stability_class() {
2986 write!(w, "<span class='stab {stab}'></span>", stab = stability_class);
2988 document(w, cx, field);
2991 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2994 fn item_enum(w: &mut Buffer, cx: &Context, it: &clean::Item, e: &clean::Enum) {
2995 wrap_into_docblock(w, |w| {
2996 write!(w, "<pre class='rust enum'>");
2997 render_attributes(w, it, true);
3001 it.visibility.print_with_space(),
3002 it.name.as_ref().unwrap(),
3004 WhereClause { gens: &e.generics, indent: 0, end_newline: true }
3006 if e.variants.is_empty() && !e.variants_stripped {
3010 for v in &e.variants {
3012 let name = v.name.as_ref().unwrap();
3014 clean::VariantItem(ref var) => match var.kind {
3015 clean::VariantKind::CLike => write!(w, "{}", name),
3016 clean::VariantKind::Tuple(ref tys) => {
3017 write!(w, "{}(", name);
3018 for (i, ty) in tys.iter().enumerate() {
3020 write!(w, ", ")
3022 write!(w, "{}", ty.print());
3026 clean::VariantKind::Struct(ref s) => {
3027 render_struct(w, v, None, s.struct_type, &s.fields, " ", false);
3030 _ => unreachable!(),
3035 if e.variants_stripped {
3036 write!(w, " // some variants omitted\n");
3043 document(w, cx, it);
3044 if !e.variants.is_empty() {
3047 "<h2 id='variants' class='variants small-section-header'>
3048 Variants{}<a href='#variants' class='anchor'></a></h2>\n",
3049 document_non_exhaustive_header(it)
3051 document_non_exhaustive(w, it);
3052 for variant in &e.variants {
3054 cx.derive_id(format!("{}.{}", ItemType::Variant, variant.name.as_ref().unwrap()));
3055 let ns_id = cx.derive_id(format!(
3057 variant.name.as_ref().unwrap(),
3058 ItemType::Variant.name_space()
3062 "<div id=\"{id}\" class=\"variant small-section-header\">\
3063 <a href=\"#{id}\" class=\"anchor field\"></a>\
3064 <code id='{ns_id}'>{name}",
3067 name = variant.name.as_ref().unwrap()
3069 if let clean::VariantItem(ref var) = variant.inner {
3070 if let clean::VariantKind::Tuple(ref tys) = var.kind {
3072 for (i, ty) in tys.iter().enumerate() {
3074 write!(w, ", ");
3076 write!(w, "{}", ty.print());
3081 write!(w, "</code></div>");
3082 document(w, cx, variant);
3083 document_non_exhaustive(w, variant);
3085 use crate::clean::{Variant, VariantKind};
3086 if let clean::VariantItem(Variant { kind: VariantKind::Struct(ref s) }) = variant.inner
3088 let variant_id = cx.derive_id(format!(
3091 variant.name.as_ref().unwrap()
3093 write!(w, "<div class='autohide sub-variant' id='{id}'>", id = variant_id);
3096 "<h3>Fields of <b>{name}</b></h3><div>",
3097 name = variant.name.as_ref().unwrap()
3099 for field in &s.fields {
3100 use crate::clean::StructFieldItem;
3101 if let StructFieldItem(ref ty) = field.inner {
3102 let id = cx.derive_id(format!(
3103 "variant.{}.field.{}",
3104 variant.name.as_ref().unwrap(),
3105 field.name.as_ref().unwrap()
3107 let ns_id = cx.derive_id(format!(
3109 variant.name.as_ref().unwrap(),
3110 ItemType::Variant.name_space(),
3111 field.name.as_ref().unwrap(),
3112 ItemType::StructField.name_space()
3116 "<span id=\"{id}\" class=\"variant small-section-header\">\
3117 <a href=\"#{id}\" class=\"anchor field\"></a>\
3118 <code id='{ns_id}'>{f}: {t}\
3122 f = field.name.as_ref().unwrap(),
3125 document(w, cx, field);
3128 write!(w, "</div></div>");
3130 render_stability_since(w, variant, it);
3133 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3136 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
3137 let path = pprust::path_to_string(&attr.path);
3141 } else if let Some(v) = attr.value_str() {
3142 Some(format!("{} = {:?}", path, v))
3143 } else if let Some(values) = attr.meta_item_list() {
3144 let display: Vec<_> = values
3146 .filter_map(|attr| attr.meta_item().and_then(|mi| render_attribute(mi)))
3149 if display.len() > 0 { Some(format!("{}({})", path, display.join(", "))) } else { None }
3155 const ATTRIBUTE_WHITELIST: &'static [Symbol] = &[
3162 sym::non_exhaustive,
3165 // The `top` parameter is used when generating the item declaration to ensure it doesn't have a
3166 // left padding. For example:
3168 // #[foo] <----- "top" attribute
3170 // #[bar] <---- not "top" attribute
3173 fn render_attributes(w: &mut Buffer, it: &clean::Item, top: bool) {
3174 let mut attrs = String::new();
3176 for attr in &it.attrs.other_attrs {
3177 if !ATTRIBUTE_WHITELIST.contains(&attr.name_or_empty()) {
3180 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
3181 attrs.push_str(&format!("#[{}]\n", s));
3184 if attrs.len() > 0 {
3187 "<span class=\"docblock attributes{}\">{}</span>",
3188 if top { " top-attr" } else { "" },
3197 g: Option<&clean::Generics>,
3198 ty: doctree::StructType,
3199 fields: &[clean::Item],
3206 it.visibility.print_with_space(),
3207 if structhead { "struct " } else { "" },
3208 it.name.as_ref().unwrap()
3210 if let Some(g) = g {
3211 write!(w, "{}", g.print())
3215 if let Some(g) = g {
3216 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })
3218 let mut has_visible_fields = false;
3220 for field in fields {
3221 if let clean::StructFieldItem(ref ty) = field.inner {
3226 field.visibility.print_with_space(),
3227 field.name.as_ref().unwrap(),
3230 has_visible_fields = true;
3234 if has_visible_fields {
3235 if it.has_stripped_fields().unwrap() {
3236 write!(w, "\n{} // some fields omitted", tab);
3238 write!(w, "\n{}", tab);
3239 } else if it.has_stripped_fields().unwrap() {
3240 // If there are no visible fields we can just display
3241 // `{ /* fields omitted */ }` to save space.
3242 write!(w, " /* fields omitted */ ");
3248 for (i, field) in fields.iter().enumerate() {
3253 clean::StrippedItem(box clean::StructFieldItem(..)) => write!(w, "_"),
3254 clean::StructFieldItem(ref ty) => {
3255 write!(w, "{}{}", field.visibility.print_with_space(), ty.print())
3257 _ => unreachable!(),
3261 if let Some(g) = g {
3262 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
3267 // Needed for PhantomData.
3268 if let Some(g) = g {
3269 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })
3279 g: Option<&clean::Generics>,
3280 fields: &[clean::Item],
3287 it.visibility.print_with_space(),
3288 if structhead { "union " } else { "" },
3289 it.name.as_ref().unwrap()
3291 if let Some(g) = g {
3292 write!(w, "{}", g.print());
3293 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true });
3296 write!(w, " {{\n{}", tab);
3297 for field in fields {
3298 if let clean::StructFieldItem(ref ty) = field.inner {
3302 field.visibility.print_with_space(),
3303 field.name.as_ref().unwrap(),
3310 if it.has_stripped_fields().unwrap() {
3311 write!(w, " // some fields omitted\n{}", tab);
3316 #[derive(Copy, Clone)]
3317 enum AssocItemLink<'a> {
3318 Anchor(Option<&'a str>),
3319 GotoSource(DefId, &'a FxHashSet<String>),
3322 impl<'a> AssocItemLink<'a> {
3323 fn anchor(&self, id: &'a String) -> Self {
3325 AssocItemLink::Anchor(_) => AssocItemLink::Anchor(Some(&id)),
3326 ref other => *other,
3331 enum AssocItemRender<'a> {
3333 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool },
3336 #[derive(Copy, Clone, PartialEq)]
3339 ForDeref { mut_: bool },
3342 fn render_assoc_items(
3345 containing_item: &clean::Item,
3347 what: AssocItemRender<'_>,
3350 let v = match c.impls.get(&it) {
3354 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| i.inner_impl().trait_.is_none());
3355 if !non_trait.is_empty() {
3356 let render_mode = match what {
3357 AssocItemRender::All => {
3361 <h2 id='methods' class='small-section-header'>\
3362 Methods<a href='#methods' class='anchor'></a>\
3368 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
3372 <h2 id='deref-methods' class='small-section-header'>\
3373 Methods from {}<Target = {}>\
3374 <a href='#deref-methods' class='anchor'></a>\
3380 RenderMode::ForDeref { mut_: deref_mut_ }
3383 for i in &non_trait {
3388 AssocItemLink::Anchor(None),
3390 containing_item.stable_since(),
3398 if let AssocItemRender::DerefFor { .. } = what {
3401 if !traits.is_empty() {
3403 traits.iter().find(|t| t.inner_impl().trait_.def_id() == c.deref_trait_did);
3404 if let Some(impl_) = deref_impl {
3405 let has_deref_mut = traits
3407 .find(|t| t.inner_impl().trait_.def_id() == c.deref_mut_trait_did)
3409 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut);
3412 let (synthetic, concrete): (Vec<&&Impl>, Vec<&&Impl>) =
3413 traits.iter().partition(|t| t.inner_impl().synthetic);
3414 let (blanket_impl, concrete): (Vec<&&Impl>, _) =
3415 concrete.into_iter().partition(|t| t.inner_impl().blanket_impl.is_some());
3417 let mut impls = Buffer::empty_from(&w);
3418 render_impls(cx, &mut impls, &concrete, containing_item);
3419 let impls = impls.into_inner();
3420 if !impls.is_empty() {
3424 <h2 id='implementations' class='small-section-header'>\
3425 Trait Implementations<a href='#implementations' class='anchor'></a>\
3427 <div id='implementations-list'>{}</div>",
3432 if !synthetic.is_empty() {
3436 <h2 id='synthetic-implementations' class='small-section-header'>\
3437 Auto Trait Implementations\
3438 <a href='#synthetic-implementations' class='anchor'></a>\
3440 <div id='synthetic-implementations-list'>\
3443 render_impls(cx, w, &synthetic, containing_item);
3444 write!(w, "</div>");
3447 if !blanket_impl.is_empty() {
3451 <h2 id='blanket-implementations' class='small-section-header'>\
3452 Blanket Implementations\
3453 <a href='#blanket-implementations' class='anchor'></a>\
3455 <div id='blanket-implementations-list'>\
3458 render_impls(cx, w, &blanket_impl, containing_item);
3459 write!(w, "</div>");
3464 fn render_deref_methods(
3468 container_item: &clean::Item,
3471 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
3472 let (target, real_target) = impl_
3476 .filter_map(|item| match item.inner {
3477 clean::TypedefItem(ref t, true) => Some(match *t {
3478 clean::Typedef { item_type: Some(ref type_), .. } => (type_, &t.type_),
3479 _ => (&t.type_, &t.type_),
3484 .expect("Expected associated type binding");
3486 AssocItemRender::DerefFor { trait_: deref_type, type_: real_target, deref_mut_: deref_mut };
3487 if let Some(did) = target.def_id() {
3488 render_assoc_items(w, cx, container_item, did, what);
3490 if let Some(prim) = target.primitive_type() {
3491 if let Some(&did) = cx.cache.primitive_locations.get(&prim) {
3492 render_assoc_items(w, cx, container_item, did, what);
3498 fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
3499 let self_type_opt = match item.inner {
3500 clean::MethodItem(ref method) => method.decl.self_type(),
3501 clean::TyMethodItem(ref method) => method.decl.self_type(),
3505 if let Some(self_ty) = self_type_opt {
3506 let (by_mut_ref, by_box, by_value) = match self_ty {
3507 SelfTy::SelfBorrowed(_, mutability)
3508 | SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
3509 (mutability == Mutability::Mut, false, false)
3511 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
3512 (false, Some(did) == cache().owned_box_did, false)
3514 SelfTy::SelfValue => (false, false, true),
3515 _ => (false, false, false),
3518 (deref_mut_ || !by_mut_ref) && !by_box && !by_value
3524 fn render_spotlight_traits(item: &clean::Item) -> String {
3526 clean::FunctionItem(clean::Function { ref decl, .. })
3527 | clean::TyMethodItem(clean::TyMethod { ref decl, .. })
3528 | clean::MethodItem(clean::Method { ref decl, .. })
3529 | clean::ForeignFunctionItem(clean::Function { ref decl, .. }) => spotlight_decl(decl),
3534 fn spotlight_decl(decl: &clean::FnDecl) -> String {
3535 let mut out = Buffer::html();
3536 let mut trait_ = String::new();
3538 if let Some(did) = decl.output.def_id() {
3540 if let Some(impls) = c.impls.get(&did) {
3542 let impl_ = i.inner_impl();
3543 if impl_.trait_.def_id().map_or(false, |d| c.traits[&d].is_spotlight) {
3545 out.push_str(&format!(
3546 "<h3 class=\"important\">Important traits for {}</h3>\
3547 <code class=\"content\">",
3550 trait_.push_str(&impl_.for_.print().to_string());
3553 //use the "where" class here to make it small
3554 out.push_str(&format!(
3555 "<span class=\"where fmt-newline\">{}</span>",
3558 let t_did = impl_.trait_.def_id().unwrap();
3559 for it in &impl_.items {
3560 if let clean::TypedefItem(ref tydef, _) = it.inner {
3561 out.push_str("<span class=\"where fmt-newline\"> ");
3567 AssocItemLink::GotoSource(t_did, &FxHashSet::default()),
3570 out.push_str(";</span>");
3578 if !out.is_empty() {
3582 "<div class=\"important-traits\"><div class='tooltip'>ⓘ\
3583 <span class='tooltiptext'>Important traits for {}</span></div>\
3584 <div class=\"content hidden\">",
3588 out.push_str("</code></div></div>");
3598 link: AssocItemLink<'_>,
3599 render_mode: RenderMode,
3600 outer_version: Option<&str>,
3601 show_def_docs: bool,
3602 use_absolute: Option<bool>,
3603 is_on_foreign_type: bool,
3604 show_default_items: bool,
3606 if render_mode == RenderMode::Normal {
3607 let id = cx.derive_id(match i.inner_impl().trait_ {
3609 if is_on_foreign_type {
3610 get_id_for_impl_on_foreign_type(&i.inner_impl().for_, t)
3612 format!("impl-{}", small_url_encode(&format!("{:#}", t.print())))
3615 None => "impl".to_string(),
3617 if let Some(use_absolute) = use_absolute {
3618 write!(w, "<h3 id='{}' class='impl'><code class='in-band'>", id);
3619 fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute);
3621 for it in &i.inner_impl().items {
3622 if let clean::TypedefItem(ref tydef, _) = it.inner {
3623 write!(w, "<span class=\"where fmt-newline\"> ");
3629 AssocItemLink::Anchor(None),
3632 write!(w, ";</span>");
3636 write!(w, "</code>");
3640 "<h3 id='{}' class='impl'><code class='in-band'>{}</code>",
3642 i.inner_impl().print()
3645 write!(w, "<a href='#{}' class='anchor'></a>", id);
3646 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
3647 render_stability_since_raw(w, since, outer_version);
3648 if let Some(l) = cx.src_href(&i.impl_item) {
3649 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>", l, "goto source code");
3652 if let Some(ref dox) = cx.shared.maybe_collapsed_doc_value(&i.impl_item) {
3653 let mut ids = cx.id_map.borrow_mut();
3656 "<div class='docblock'>{}</div>",
3659 &i.impl_item.links(),
3663 &cx.shared.playground
3674 link: AssocItemLink<'_>,
3675 render_mode: RenderMode,
3676 is_default_item: bool,
3677 outer_version: Option<&str>,
3678 trait_: Option<&clean::Trait>,
3679 show_def_docs: bool,
3681 let item_type = item.type_();
3682 let name = item.name.as_ref().unwrap();
3684 let render_method_item = match render_mode {
3685 RenderMode::Normal => true,
3686 RenderMode::ForDeref { mut_: deref_mut_ } => should_render_item(&item, deref_mut_),
3689 let (is_hidden, extra_class) =
3690 if (trait_.is_none() || item.doc_value().is_some() || item.inner.is_associated())
3698 clean::MethodItem(clean::Method { ref decl, .. })
3699 | clean::TyMethodItem(clean::TyMethod { ref decl, .. }) => {
3700 // Only render when the method is not static or we allow static methods
3701 if render_method_item {
3702 let id = cx.derive_id(format!("{}.{}", item_type, name));
3703 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3704 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3705 write!(w, "{}", spotlight_decl(decl));
3706 write!(w, "<code id='{}'>", ns_id);
3707 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl);
3708 write!(w, "</code>");
3709 render_stability_since_raw(w, item.stable_since(), outer_version);
3710 if let Some(l) = cx.src_href(item) {
3713 "<a class='srclink' href='{}' title='{}'>[src]</a>",
3714 l, "goto source code"
3720 clean::TypedefItem(ref tydef, _) => {
3721 let id = cx.derive_id(format!("{}.{}", ItemType::AssocType, name));
3722 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3723 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3724 write!(w, "<code id='{}'>", ns_id);
3725 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id), "");
3726 write!(w, "</code></h4>");
3728 clean::AssocConstItem(ref ty, ref default) => {
3729 let id = cx.derive_id(format!("{}.{}", item_type, name));
3730 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3731 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3732 write!(w, "<code id='{}'>", ns_id);
3733 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id), "");
3734 write!(w, "</code>");
3735 render_stability_since_raw(w, item.stable_since(), outer_version);
3736 if let Some(l) = cx.src_href(item) {
3739 "<a class='srclink' href='{}' title='{}'>[src]</a>",
3740 l, "goto source code"
3745 clean::AssocTypeItem(ref bounds, ref default) => {
3746 let id = cx.derive_id(format!("{}.{}", item_type, name));
3747 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3748 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class);
3749 write!(w, "<code id='{}'>", ns_id);
3750 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id), "");
3751 write!(w, "</code></h4>");
3753 clean::StrippedItem(..) => return,
3754 _ => panic!("can't make docs for trait item with name {:?}", item.name),
3757 if render_method_item {
3758 if !is_default_item {
3759 if let Some(t) = trait_ {
3760 // The trait item may have been stripped so we might not
3761 // find any documentation or stability for it.
3762 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
3763 // We need the stability of the item from the trait
3764 // because impls can't have a stability.
3765 document_stability(w, cx, it, is_hidden);
3766 if item.doc_value().is_some() {
3767 document_full(w, item, cx, "", is_hidden);
3768 } else if show_def_docs {
3769 // In case the item isn't documented,
3770 // provide short documentation from the trait.
3771 document_short(w, cx, it, link, "", is_hidden);
3775 document_stability(w, cx, item, is_hidden);
3777 document_full(w, item, cx, "", is_hidden);
3781 document_stability(w, cx, item, is_hidden);
3783 document_short(w, cx, item, link, "", is_hidden);
3789 let traits = &cx.cache.traits;
3790 let trait_ = i.trait_did().map(|did| &traits[&did]);
3792 write!(w, "<div class='impl-items'>");
3793 for trait_item in &i.inner_impl().items {
3807 fn render_default_items(
3812 render_mode: RenderMode,
3813 outer_version: Option<&str>,
3814 show_def_docs: bool,
3816 for trait_item in &t.items {
3817 let n = trait_item.name.clone();
3818 if i.items.iter().find(|m| m.name == n).is_some() {
3821 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3822 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3838 // If we've implemented a trait, then also emit documentation for all
3839 // default items which weren't overridden in the implementation block.
3840 // We don't emit documentation for default items if they appear in the
3841 // Implementations on Foreign Types or Implementors sections.
3842 if show_default_items {
3843 if let Some(t) = trait_ {
3844 render_default_items(
3855 write!(w, "</div>");
3858 fn item_opaque_ty(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::OpaqueTy) {
3859 write!(w, "<pre class='rust opaque'>");
3860 render_attributes(w, it, false);
3863 "type {}{}{where_clause} = impl {bounds};</pre>",
3864 it.name.as_ref().unwrap(),
3866 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3867 bounds = bounds(&t.bounds, false)
3870 document(w, cx, it);
3872 // Render any items associated directly to this alias, as otherwise they
3873 // won't be visible anywhere in the docs. It would be nice to also show
3874 // associated items from the aliased type (see discussion in #32077), but
3875 // we need #14072 to make sense of the generics.
3876 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3879 fn item_trait_alias(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::TraitAlias) {
3880 write!(w, "<pre class='rust trait-alias'>");
3881 render_attributes(w, it, false);
3884 "trait {}{}{} = {};</pre>",
3885 it.name.as_ref().unwrap(),
3887 WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3888 bounds(&t.bounds, true)
3891 document(w, cx, it);
3893 // Render any items associated directly to this alias, as otherwise they
3894 // won't be visible anywhere in the docs. It would be nice to also show
3895 // associated items from the aliased type (see discussion in #32077), but
3896 // we need #14072 to make sense of the generics.
3897 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3900 fn item_typedef(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Typedef) {
3901 write!(w, "<pre class='rust typedef'>");
3902 render_attributes(w, it, false);
3905 "type {}{}{where_clause} = {type_};</pre>",
3906 it.name.as_ref().unwrap(),
3908 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3909 type_ = t.type_.print()
3912 document(w, cx, it);
3914 // Render any items associated directly to this alias, as otherwise they
3915 // won't be visible anywhere in the docs. It would be nice to also show
3916 // associated items from the aliased type (see discussion in #32077), but
3917 // we need #14072 to make sense of the generics.
3918 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3921 fn item_foreign_type(w: &mut Buffer, cx: &Context, it: &clean::Item) {
3922 writeln!(w, "<pre class='rust foreigntype'>extern {{");
3923 render_attributes(w, it, false);
3926 " {}type {};\n}}</pre>",
3927 it.visibility.print_with_space(),
3928 it.name.as_ref().unwrap(),
3931 document(w, cx, it);
3933 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3936 fn print_sidebar(cx: &Context, it: &clean::Item, buffer: &mut Buffer) {
3937 let parentlen = cx.current.len() - if it.is_mod() { 1 } else { 0 };
3941 || it.is_primitive()
3949 "<p class='location'>{}{}</p>",
3951 clean::StructItem(..) => "Struct ",
3952 clean::TraitItem(..) => "Trait ",
3953 clean::PrimitiveItem(..) => "Primitive Type ",
3954 clean::UnionItem(..) => "Union ",
3955 clean::EnumItem(..) => "Enum ",
3956 clean::TypedefItem(..) => "Type Definition ",
3957 clean::ForeignTypeItem => "Foreign Type ",
3958 clean::ModuleItem(..) =>
3966 it.name.as_ref().unwrap()
3971 if let Some(ref version) = cx.cache.crate_version {
3974 "<div class='block version'>\
3982 write!(buffer, "<div class=\"sidebar-elems\">");
3986 "<a id='all-types' href='all.html'><p>See all {}'s items</p></a>",
3987 it.name.as_ref().expect("crates always have a name")
3991 clean::StructItem(ref s) => sidebar_struct(buffer, it, s),
3992 clean::TraitItem(ref t) => sidebar_trait(buffer, it, t),
3993 clean::PrimitiveItem(_) => sidebar_primitive(buffer, it),
3994 clean::UnionItem(ref u) => sidebar_union(buffer, it, u),
3995 clean::EnumItem(ref e) => sidebar_enum(buffer, it, e),
3996 clean::TypedefItem(_, _) => sidebar_typedef(buffer, it),
3997 clean::ModuleItem(ref m) => sidebar_module(buffer, &m.items),
3998 clean::ForeignTypeItem => sidebar_foreign_type(buffer, it),
4002 // The sidebar is designed to display sibling functions, modules and
4003 // other miscellaneous information. since there are lots of sibling
4004 // items (and that causes quadratic growth in large modules),
4005 // we refactor common parts into a shared JavaScript file per module.
4006 // still, we don't move everything into JS because we want to preserve
4007 // as much HTML as possible in order to allow non-JS-enabled browsers
4008 // to navigate the documentation (though slightly inefficiently).
4010 write!(buffer, "<p class='location'>");
4011 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
4013 write!(buffer, "::<wbr>");
4017 "<a href='{}index.html'>{}</a>",
4018 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
4022 write!(buffer, "</p>");
4024 // Sidebar refers to the enclosing module, not this module.
4025 let relpath = if it.is_mod() { "../" } else { "" };
4028 "<script>window.sidebarCurrent = {{\
4033 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
4038 // There is no sidebar-items.js beyond the crate root path
4039 // FIXME maybe dynamic crate loading can be merged here
4041 write!(buffer, "<script defer src=\"{path}sidebar-items.js\"></script>", path = relpath);
4043 // Closes sidebar-elems div.
4044 write!(buffer, "</div>");
4047 fn get_next_url(used_links: &mut FxHashSet<String>, url: String) -> String {
4048 if used_links.insert(url.clone()) {
4052 while used_links.insert(format!("{}-{}", url, add)) == false {
4055 format!("{}-{}", url, add)
4061 used_links: &mut FxHashSet<String>,
4066 .filter_map(|item| match item.name {
4067 Some(ref name) if !name.is_empty() && item.is_method() => {
4068 if !for_deref || should_render_item(item, deref_mut) {
4070 "<a href=\"#{}\">{}</a>",
4071 get_next_url(used_links, format!("method.{}", name)),
4080 .collect::<Vec<_>>()
4083 // The point is to url encode any potential character from a type with genericity.
4084 fn small_url_encode(s: &str) -> String {
4085 s.replace("<", "%3C")
4086 .replace(">", "%3E")
4087 .replace(" ", "%20")
4088 .replace("?", "%3F")
4089 .replace("'", "%27")
4090 .replace("&", "%26")
4091 .replace(",", "%2C")
4092 .replace(":", "%3A")
4093 .replace(";", "%3B")
4094 .replace("[", "%5B")
4095 .replace("]", "%5D")
4096 .replace("\"", "%22")
4099 fn sidebar_assoc_items(it: &clean::Item) -> String {
4100 let mut out = String::new();
4102 if let Some(v) = c.impls.get(&it.def_id) {
4103 let mut used_links = FxHashSet::default();
4106 let used_links_bor = &mut used_links;
4109 .filter(|i| i.inner_impl().trait_.is_none())
4110 .flat_map(move |i| get_methods(i.inner_impl(), false, used_links_bor, false))
4111 .collect::<Vec<_>>();
4112 // We want links' order to be reproducible so we don't use unstable sort.
4114 if !ret.is_empty() {
4115 out.push_str(&format!(
4116 "<a class=\"sidebar-title\" href=\"#methods\">Methods\
4117 </a><div class=\"sidebar-links\">{}</div>",
4123 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
4124 if let Some(impl_) = v
4126 .filter(|i| i.inner_impl().trait_.is_some())
4127 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did)
4129 if let Some((target, real_target)) = impl_
4133 .filter_map(|item| match item.inner {
4134 clean::TypedefItem(ref t, true) => Some(match *t {
4135 clean::Typedef { item_type: Some(ref type_), .. } => (type_, &t.type_),
4136 _ => (&t.type_, &t.type_),
4142 let inner_impl = target
4146 .and_then(|prim| c.primitive_locations.get(&prim).cloned()))
4147 .and_then(|did| c.impls.get(&did));
4148 if let Some(impls) = inner_impl {
4149 out.push_str("<a class=\"sidebar-title\" href=\"#deref-methods\">");
4150 out.push_str(&format!(
4151 "Methods from {}<Target={}>",
4154 impl_.inner_impl().trait_.as_ref().unwrap().print()
4156 Escape(&format!("{:#}", real_target.print()))
4158 out.push_str("</a>");
4161 .filter(|i| i.inner_impl().trait_.is_none())
4162 .flat_map(|i| get_methods(i.inner_impl(), true, &mut used_links, true))
4163 .collect::<Vec<_>>();
4164 // We want links' order to be reproducible so we don't use unstable sort.
4166 if !ret.is_empty() {
4167 out.push_str(&format!(
4168 "<div class=\"sidebar-links\">{}</div>",
4175 let format_impls = |impls: Vec<&Impl>| {
4176 let mut links = FxHashSet::default();
4181 let is_negative_impl = is_negative_impl(i.inner_impl());
4182 if let Some(ref i) = i.inner_impl().trait_ {
4183 let i_display = format!("{:#}", i.print());
4184 let out = Escape(&i_display);
4185 let encoded = small_url_encode(&format!("{:#}", i.print()));
4186 let generated = format!(
4187 "<a href=\"#impl-{}\">{}{}</a>",
4189 if is_negative_impl { "!" } else { "" },
4192 if links.insert(generated.clone()) { Some(generated) } else { None }
4197 .collect::<Vec<String>>();
4202 let (synthetic, concrete): (Vec<&Impl>, Vec<&Impl>) =
4203 v.iter().partition::<Vec<_>, _>(|i| i.inner_impl().synthetic);
4204 let (blanket_impl, concrete): (Vec<&Impl>, Vec<&Impl>) = concrete
4206 .partition::<Vec<_>, _>(|i| i.inner_impl().blanket_impl.is_some());
4208 let concrete_format = format_impls(concrete);
4209 let synthetic_format = format_impls(synthetic);
4210 let blanket_format = format_impls(blanket_impl);
4212 if !concrete_format.is_empty() {
4214 "<a class=\"sidebar-title\" href=\"#implementations\">\
4215 Trait Implementations</a>",
4217 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", concrete_format));
4220 if !synthetic_format.is_empty() {
4222 "<a class=\"sidebar-title\" href=\"#synthetic-implementations\">\
4223 Auto Trait Implementations</a>",
4225 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", synthetic_format));
4228 if !blanket_format.is_empty() {
4230 "<a class=\"sidebar-title\" href=\"#blanket-implementations\">\
4231 Blanket Implementations</a>",
4233 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", blanket_format));
4241 fn sidebar_struct(buf: &mut Buffer, it: &clean::Item, s: &clean::Struct) {
4242 let mut sidebar = String::new();
4243 let fields = get_struct_fields_name(&s.fields);
4245 if !fields.is_empty() {
4246 if let doctree::Plain = s.struct_type {
4247 sidebar.push_str(&format!(
4248 "<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4249 <div class=\"sidebar-links\">{}</div>",
4255 sidebar.push_str(&sidebar_assoc_items(it));
4257 if !sidebar.is_empty() {
4258 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4262 fn get_id_for_impl_on_foreign_type(for_: &clean::Type, trait_: &clean::Type) -> String {
4263 small_url_encode(&format!("impl-{:#}-for-{:#}", trait_.print(), for_.print()))
4266 fn extract_for_impl_name(item: &clean::Item) -> Option<(String, String)> {
4268 clean::ItemEnum::ImplItem(ref i) => {
4269 if let Some(ref trait_) = i.trait_ {
4271 format!("{:#}", i.for_.print()),
4272 get_id_for_impl_on_foreign_type(&i.for_, trait_),
4282 fn is_negative_impl(i: &clean::Impl) -> bool {
4283 i.polarity == Some(clean::ImplPolarity::Negative)
4286 fn sidebar_trait(buf: &mut Buffer, it: &clean::Item, t: &clean::Trait) {
4287 let mut sidebar = String::new();
4292 .filter_map(|m| match m.name {
4293 Some(ref name) if m.is_associated_type() => {
4294 Some(format!("<a href=\"#associatedtype.{name}\">{name}</a>", name = name))
4298 .collect::<String>();
4302 .filter_map(|m| match m.name {
4303 Some(ref name) if m.is_associated_const() => {
4304 Some(format!("<a href=\"#associatedconstant.{name}\">{name}</a>", name = name))
4308 .collect::<String>();
4309 let mut required = t
4312 .filter_map(|m| match m.name {
4313 Some(ref name) if m.is_ty_method() => {
4314 Some(format!("<a href=\"#tymethod.{name}\">{name}</a>", name = name))
4318 .collect::<Vec<String>>();
4319 let mut provided = t
4322 .filter_map(|m| match m.name {
4323 Some(ref name) if m.is_method() => {
4324 Some(format!("<a href=\"#method.{0}\">{0}</a>", name))
4328 .collect::<Vec<String>>();
4330 if !types.is_empty() {
4331 sidebar.push_str(&format!(
4332 "<a class=\"sidebar-title\" href=\"#associated-types\">\
4333 Associated Types</a><div class=\"sidebar-links\">{}</div>",
4337 if !consts.is_empty() {
4338 sidebar.push_str(&format!(
4339 "<a class=\"sidebar-title\" href=\"#associated-const\">\
4340 Associated Constants</a><div class=\"sidebar-links\">{}</div>",
4344 if !required.is_empty() {
4346 sidebar.push_str(&format!(
4347 "<a class=\"sidebar-title\" href=\"#required-methods\">\
4348 Required Methods</a><div class=\"sidebar-links\">{}</div>",
4352 if !provided.is_empty() {
4354 sidebar.push_str(&format!(
4355 "<a class=\"sidebar-title\" href=\"#provided-methods\">\
4356 Provided Methods</a><div class=\"sidebar-links\">{}</div>",
4363 if let Some(implementors) = c.implementors.get(&it.def_id) {
4364 let mut res = implementors
4366 .filter(|i| i.inner_impl().for_.def_id().map_or(false, |d| !c.paths.contains_key(&d)))
4367 .filter_map(|i| match extract_for_impl_name(&i.impl_item) {
4368 Some((ref name, ref id)) => {
4369 Some(format!("<a href=\"#{}\">{}</a>", id, Escape(name)))
4373 .collect::<Vec<String>>();
4374 if !res.is_empty() {
4376 sidebar.push_str(&format!(
4377 "<a class=\"sidebar-title\" href=\"#foreign-impls\">\
4378 Implementations on Foreign Types</a><div \
4379 class=\"sidebar-links\">{}</div>",
4385 sidebar.push_str("<a class=\"sidebar-title\" href=\"#implementors\">Implementors</a>");
4388 "<a class=\"sidebar-title\" \
4389 href=\"#synthetic-implementors\">Auto Implementors</a>",
4393 sidebar.push_str(&sidebar_assoc_items(it));
4395 write!(buf, "<div class=\"block items\">{}</div>", sidebar)
4398 fn sidebar_primitive(buf: &mut Buffer, it: &clean::Item) {
4399 let sidebar = sidebar_assoc_items(it);
4401 if !sidebar.is_empty() {
4402 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4406 fn sidebar_typedef(buf: &mut Buffer, it: &clean::Item) {
4407 let sidebar = sidebar_assoc_items(it);
4409 if !sidebar.is_empty() {
4410 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4414 fn get_struct_fields_name(fields: &[clean::Item]) -> String {
4417 .filter(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false })
4418 .filter_map(|f| match f.name {
4419 Some(ref name) => Some(format!(
4420 "<a href=\"#structfield.{name}\">\
4429 fn sidebar_union(buf: &mut Buffer, it: &clean::Item, u: &clean::Union) {
4430 let mut sidebar = String::new();
4431 let fields = get_struct_fields_name(&u.fields);
4433 if !fields.is_empty() {
4434 sidebar.push_str(&format!(
4435 "<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4436 <div class=\"sidebar-links\">{}</div>",
4441 sidebar.push_str(&sidebar_assoc_items(it));
4443 if !sidebar.is_empty() {
4444 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4448 fn sidebar_enum(buf: &mut Buffer, it: &clean::Item, e: &clean::Enum) {
4449 let mut sidebar = String::new();
4454 .filter_map(|v| match v.name {
4455 Some(ref name) => Some(format!(
4456 "<a href=\"#variant.{name}\">{name}\
4462 .collect::<String>();
4463 if !variants.is_empty() {
4464 sidebar.push_str(&format!(
4465 "<a class=\"sidebar-title\" href=\"#variants\">Variants</a>\
4466 <div class=\"sidebar-links\">{}</div>",
4471 sidebar.push_str(&sidebar_assoc_items(it));
4473 if !sidebar.is_empty() {
4474 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4478 fn item_ty_to_strs(ty: &ItemType) -> (&'static str, &'static str) {
4480 ItemType::ExternCrate | ItemType::Import => ("reexports", "Re-exports"),
4481 ItemType::Module => ("modules", "Modules"),
4482 ItemType::Struct => ("structs", "Structs"),
4483 ItemType::Union => ("unions", "Unions"),
4484 ItemType::Enum => ("enums", "Enums"),
4485 ItemType::Function => ("functions", "Functions"),
4486 ItemType::Typedef => ("types", "Type Definitions"),
4487 ItemType::Static => ("statics", "Statics"),
4488 ItemType::Constant => ("constants", "Constants"),
4489 ItemType::Trait => ("traits", "Traits"),
4490 ItemType::Impl => ("impls", "Implementations"),
4491 ItemType::TyMethod => ("tymethods", "Type Methods"),
4492 ItemType::Method => ("methods", "Methods"),
4493 ItemType::StructField => ("fields", "Struct Fields"),
4494 ItemType::Variant => ("variants", "Variants"),
4495 ItemType::Macro => ("macros", "Macros"),
4496 ItemType::Primitive => ("primitives", "Primitive Types"),
4497 ItemType::AssocType => ("associated-types", "Associated Types"),
4498 ItemType::AssocConst => ("associated-consts", "Associated Constants"),
4499 ItemType::ForeignType => ("foreign-types", "Foreign Types"),
4500 ItemType::Keyword => ("keywords", "Keywords"),
4501 ItemType::OpaqueTy => ("opaque-types", "Opaque Types"),
4502 ItemType::ProcAttribute => ("attributes", "Attribute Macros"),
4503 ItemType::ProcDerive => ("derives", "Derive Macros"),
4504 ItemType::TraitAlias => ("trait-aliases", "Trait aliases"),
4508 fn sidebar_module(buf: &mut Buffer, items: &[clean::Item]) {
4509 let mut sidebar = String::new();
4511 if items.iter().any(|it| it.type_() == ItemType::ExternCrate || it.type_() == ItemType::Import)
4513 sidebar.push_str(&format!(
4514 "<li><a href=\"#{id}\">{name}</a></li>",
4520 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
4521 // to print its headings
4523 ItemType::Primitive,
4537 ItemType::StructField,
4539 ItemType::AssocType,
4540 ItemType::AssocConst,
4541 ItemType::ForeignType,
4544 if items.iter().any(|it| !it.is_stripped() && it.type_() == myty) {
4545 let (short, name) = item_ty_to_strs(&myty);
4546 sidebar.push_str(&format!(
4547 "<li><a href=\"#{id}\">{name}</a></li>",
4554 if !sidebar.is_empty() {
4555 write!(buf, "<div class=\"block items\"><ul>{}</ul></div>", sidebar);
4559 fn sidebar_foreign_type(buf: &mut Buffer, it: &clean::Item) {
4560 let sidebar = sidebar_assoc_items(it);
4561 if !sidebar.is_empty() {
4562 write!(buf, "<div class=\"block items\">{}</div>", sidebar);
4566 fn item_macro(w: &mut Buffer, cx: &Context, it: &clean::Item, t: &clean::Macro) {
4567 wrap_into_docblock(w, |w| {
4568 w.write_str(&highlight::render_with_highlighting(&t.source, Some("macro"), None, None))
4573 fn item_proc_macro(w: &mut Buffer, cx: &Context, it: &clean::Item, m: &clean::ProcMacro) {
4574 let name = it.name.as_ref().expect("proc-macros always have names");
4576 MacroKind::Bang => {
4577 write!(w, "<pre class='rust macro'>");
4578 write!(w, "{}!() {{ /* proc-macro */ }}", name);
4579 write!(w, "</pre>");
4581 MacroKind::Attr => {
4582 write!(w, "<pre class='rust attr'>");
4583 write!(w, "#[{}]", name);
4584 write!(w, "</pre>");
4586 MacroKind::Derive => {
4587 write!(w, "<pre class='rust derive'>");
4588 write!(w, "#[derive({})]", name);
4589 if !m.helpers.is_empty() {
4590 writeln!(w, "\n{{");
4591 writeln!(w, " // Attributes available to this derive:");
4592 for attr in &m.helpers {
4593 writeln!(w, " #[{}]", attr);
4597 write!(w, "</pre>");
4603 fn item_primitive(w: &mut Buffer, cx: &Context, it: &clean::Item) {
4604 document(w, cx, it);
4605 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4608 fn item_keyword(w: &mut Buffer, cx: &Context, it: &clean::Item) {
4612 crate const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
4614 fn make_item_keywords(it: &clean::Item) -> String {
4615 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
4618 /// Returns a list of all paths used in the type.
4619 /// This is used to help deduplicate imported impls
4620 /// for reexported types. If any of the contained
4621 /// types are re-exported, we don't use the corresponding
4622 /// entry from the js file, as inlining will have already
4623 /// picked up the impl
4624 fn collect_paths_for_type(first_ty: clean::Type) -> Vec<String> {
4625 let mut out = Vec::new();
4626 let mut visited = FxHashSet::default();
4627 let mut work = VecDeque::new();
4628 let cache = cache();
4630 work.push_back(first_ty);
4632 while let Some(ty) = work.pop_front() {
4633 if !visited.insert(ty.clone()) {
4638 clean::Type::ResolvedPath { did, .. } => {
4639 let get_extern = || cache.external_paths.get(&did).map(|s| s.0.clone());
4640 let fqp = cache.exact_paths.get(&did).cloned().or_else(get_extern);
4644 out.push(path.join("::"));
4649 clean::Type::Tuple(tys) => {
4650 work.extend(tys.into_iter());
4652 clean::Type::Slice(ty) => {
4653 work.push_back(*ty);
4655 clean::Type::Array(ty, _) => {
4656 work.push_back(*ty);
4658 clean::Type::RawPointer(_, ty) => {
4659 work.push_back(*ty);
4661 clean::Type::BorrowedRef { type_, .. } => {
4662 work.push_back(*type_);
4664 clean::Type::QPath { self_type, trait_, .. } => {
4665 work.push_back(*self_type);
4666 work.push_back(*trait_);
4674 crate fn cache() -> Arc<Cache> {
4675 CACHE_KEY.with(|c| c.borrow().clone())