1 // Copyright 2013-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Rustdoc's HTML Rendering module
13 //! This modules contains the bulk of the logic necessary for rendering a
14 //! rustdoc `clean::Crate` instance to a set of static HTML pages. This
15 //! rendering process is largely driven by the `format!` syntax extension to
16 //! perform all I/O into files and streams.
18 //! The rendering process is largely driven by the `Context` and `Cache`
19 //! structures. The cache is pre-populated by crawling the crate in question,
20 //! and then it is shared among the various rendering threads. The cache is meant
21 //! to be a fairly large structure not implementing `Clone` (because it's shared
22 //! among threads). The context, however, should be a lightweight structure. This
23 //! is cloned per-thread and contains information about what is currently being
26 //! In order to speed up rendering (mostly because of markdown rendering), the
27 //! rendering process has been parallelized. This parallelization is only
28 //! exposed through the `crate` method on the context, and then also from the
29 //! fact that the shared cache is stored in TLS (and must be accessed as such).
31 //! In addition to rendering the crate itself, this module is also responsible
32 //! for creating the corresponding search index and source file renderings.
33 //! These threads are not parallelized (they haven't been a bottleneck yet), and
34 //! both occur before the crate is rendered.
35 pub use self::ExternalLocation::*;
37 use std::ascii::AsciiExt;
38 use std::cell::RefCell;
39 use std::cmp::Ordering;
40 use std::collections::BTreeMap;
41 use std::default::Default;
43 use std::fmt::{self, Display, Formatter, Write as FmtWrite};
44 use std::fs::{self, File, OpenOptions};
45 use std::io::prelude::*;
46 use std::io::{self, BufWriter, BufReader};
47 use std::iter::repeat;
49 use std::path::{PathBuf, Path, Component};
53 use externalfiles::ExternalHtml;
55 use serialize::json::{ToJson, Json, as_json};
56 use syntax::{abi, ast};
57 use syntax::feature_gate::UnstableFeatures;
58 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
59 use rustc::middle::privacy::AccessLevels;
60 use rustc::middle::stability;
62 use rustc::util::nodemap::{FxHashMap, FxHashSet};
63 use rustc::session::config::nightly_options::is_nightly_build;
64 use rustc_data_structures::flock;
66 use clean::{self, AttributesExt, GetDefId, SelfTy, Mutability};
69 use html::escape::Escape;
70 use html::format::{ConstnessSpace};
71 use html::format::{TyParamBounds, WhereClause, href, AbiSpace};
72 use html::format::{VisSpace, Method, UnsafetySpace, MutableSpace};
73 use html::format::fmt_impl_for_trait_page;
74 use html::item_type::ItemType;
75 use html::markdown::{self, Markdown, MarkdownHtml, MarkdownSummaryLine, RenderType};
76 use html::{highlight, layout};
78 /// A pair of name and its optional document.
79 pub type NameDoc = (String, Option<String>);
81 /// Major driving force in all rustdoc rendering. This contains information
82 /// about where in the tree-like hierarchy rendering is occurring and controls
83 /// how the current page is being rendered.
85 /// It is intended that this context is a lightweight object which can be fairly
86 /// easily cloned because it is cloned per work-job (about once per item in the
90 /// Current hierarchy of components leading down to what's currently being
92 pub current: Vec<String>,
93 /// The current destination folder of where HTML artifacts should be placed.
94 /// This changes as the context descends into the module hierarchy.
96 /// A flag, which when `true`, will render pages which redirect to the
97 /// real location of an item. This is used to allow external links to
98 /// publicly reused items to redirect to the right location.
99 pub render_redirect_pages: bool,
100 pub shared: Arc<SharedContext>,
101 pub render_type: RenderType,
104 pub struct SharedContext {
105 /// The path to the crate root source minus the file name.
106 /// Used for simplifying paths to the highlighted source code files.
107 pub src_root: PathBuf,
108 /// This describes the layout of each page, and is not modified after
109 /// creation of the context (contains info like the favicon and added html).
110 pub layout: layout::Layout,
111 /// This flag indicates whether [src] links should be generated or not. If
112 /// the source files are present in the html rendering, then this will be
114 pub include_sources: bool,
115 /// The local file sources we've emitted and their respective url-paths.
116 pub local_sources: FxHashMap<PathBuf, String>,
117 /// All the passes that were run on this crate.
118 pub passes: FxHashSet<String>,
119 /// The base-URL of the issue tracker for when an item has been tagged with
121 pub issue_tracker_base_url: Option<String>,
122 /// The given user css file which allow to customize the generated
123 /// documentation theme.
124 pub css_file_extension: Option<PathBuf>,
127 /// Indicates where an external crate can be found.
128 pub enum ExternalLocation {
129 /// Remote URL root of the external crate
131 /// This external crate can be found in the local doc/ folder
133 /// The external crate could not be found.
137 /// Metadata about an implementor of a trait.
138 pub struct Implementor {
140 pub stability: Option<clean::Stability>,
141 pub impl_: clean::Impl,
144 /// Metadata about implementations for a type.
147 pub impl_item: clean::Item,
151 fn inner_impl(&self) -> &clean::Impl {
152 match self.impl_item.inner {
153 clean::ImplItem(ref impl_) => impl_,
154 _ => panic!("non-impl item found in impl")
158 fn trait_did(&self) -> Option<DefId> {
159 self.inner_impl().trait_.def_id()
169 impl error::Error for Error {
170 fn description(&self) -> &str {
171 self.error.description()
175 impl Display for Error {
176 fn fmt(&self, f: &mut Formatter) -> fmt::Result {
177 write!(f, "\"{}\": {}", self.file.display(), self.error)
182 pub fn new(e: io::Error, file: &Path) -> Error {
184 file: file.to_path_buf(),
190 macro_rules! try_err {
191 ($e:expr, $file:expr) => ({
194 Err(e) => return Err(Error::new(e, $file)),
199 /// This cache is used to store information about the `clean::Crate` being
200 /// rendered in order to provide more useful documentation. This contains
201 /// information like all implementors of a trait, all traits a type implements,
202 /// documentation for all known traits, etc.
204 /// This structure purposefully does not implement `Clone` because it's intended
205 /// to be a fairly large and expensive structure to clone. Instead this adheres
206 /// to `Send` so it may be stored in a `Arc` instance and shared among the various
207 /// rendering threads.
210 /// Mapping of typaram ids to the name of the type parameter. This is used
211 /// when pretty-printing a type (so pretty printing doesn't have to
212 /// painfully maintain a context like this)
213 pub typarams: FxHashMap<DefId, String>,
215 /// Maps a type id to all known implementations for that type. This is only
216 /// recognized for intra-crate `ResolvedPath` types, and is used to print
217 /// out extra documentation on the page of an enum/struct.
219 /// The values of the map are a list of implementations and documentation
220 /// found on that implementation.
221 pub impls: FxHashMap<DefId, Vec<Impl>>,
223 /// Maintains a mapping of local crate node ids to the fully qualified name
224 /// and "short type description" of that node. This is used when generating
225 /// URLs when a type is being linked to. External paths are not located in
226 /// this map because the `External` type itself has all the information
228 pub paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
230 /// Similar to `paths`, but only holds external paths. This is only used for
231 /// generating explicit hyperlinks to other crates.
232 pub external_paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
234 /// This map contains information about all known traits of this crate.
235 /// Implementations of a crate should inherit the documentation of the
236 /// parent trait if no extra documentation is specified, and default methods
237 /// should show up in documentation about trait implementations.
238 pub traits: FxHashMap<DefId, clean::Trait>,
240 /// When rendering traits, it's often useful to be able to list all
241 /// implementors of the trait, and this mapping is exactly, that: a mapping
242 /// of trait ids to the list of known implementors of the trait
243 pub implementors: FxHashMap<DefId, Vec<Implementor>>,
245 /// Cache of where external crate documentation can be found.
246 pub extern_locations: FxHashMap<CrateNum, (String, PathBuf, ExternalLocation)>,
248 /// Cache of where documentation for primitives can be found.
249 pub primitive_locations: FxHashMap<clean::PrimitiveType, DefId>,
251 // Note that external items for which `doc(hidden)` applies to are shown as
252 // non-reachable while local items aren't. This is because we're reusing
253 // the access levels from crateanalysis.
254 pub access_levels: Arc<AccessLevels<DefId>>,
256 // Private fields only used when initially crawling a crate to build a cache
259 parent_stack: Vec<DefId>,
260 parent_is_trait_impl: bool,
261 search_index: Vec<IndexItem>,
263 deref_trait_did: Option<DefId>,
264 deref_mut_trait_did: Option<DefId>,
265 owned_box_did: Option<DefId>,
267 // In rare case where a structure is defined in one module but implemented
268 // in another, if the implementing module is parsed before defining module,
269 // then the fully qualified name of the structure isn't presented in `paths`
270 // yet when its implementation methods are being indexed. Caches such methods
271 // and their parent id here and indexes them at the end of crate parsing.
272 orphan_impl_items: Vec<(DefId, clean::Item)>,
275 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
276 /// Later on moved into `CACHE_KEY`.
278 pub struct RenderInfo {
279 pub inlined: FxHashSet<DefId>,
280 pub external_paths: ::core::ExternalPaths,
281 pub external_typarams: FxHashMap<DefId, String>,
282 pub deref_trait_did: Option<DefId>,
283 pub deref_mut_trait_did: Option<DefId>,
284 pub owned_box_did: Option<DefId>,
287 /// Helper struct to render all source code to HTML pages
288 struct SourceCollector<'a> {
289 scx: &'a mut SharedContext,
291 /// Root destination to place all HTML output into
295 /// Wrapper struct to render the source code of a file. This will do things like
296 /// adding line numbers to the left-hand side.
297 struct Source<'a>(&'a str);
299 // Helper structs for rendering items/sidebars and carrying along contextual
302 #[derive(Copy, Clone)]
305 item: &'a clean::Item,
308 struct Sidebar<'a> { cx: &'a Context, item: &'a clean::Item, }
310 /// Struct representing one entry in the JS search index. These are all emitted
311 /// by hand to a large JS file at the end of cache-creation.
317 parent: Option<DefId>,
318 parent_idx: Option<usize>,
319 search_type: Option<IndexItemFunctionType>,
322 impl ToJson for IndexItem {
323 fn to_json(&self) -> Json {
324 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
326 let mut data = Vec::with_capacity(6);
327 data.push((self.ty as usize).to_json());
328 data.push(self.name.to_json());
329 data.push(self.path.to_json());
330 data.push(self.desc.to_json());
331 data.push(self.parent_idx.to_json());
332 data.push(self.search_type.to_json());
338 /// A type used for the search index.
340 name: Option<String>,
343 impl ToJson for Type {
344 fn to_json(&self) -> Json {
347 let mut data = BTreeMap::new();
348 data.insert("name".to_owned(), name.to_json());
356 /// Full type of functions/methods in the search index.
357 struct IndexItemFunctionType {
362 impl ToJson for IndexItemFunctionType {
363 fn to_json(&self) -> Json {
364 // If we couldn't figure out a type, just write `null`.
365 if self.inputs.iter().chain(self.output.iter()).any(|ref i| i.name.is_none()) {
368 let mut data = BTreeMap::new();
369 data.insert("inputs".to_owned(), self.inputs.to_json());
370 data.insert("output".to_owned(), self.output.to_json());
376 // TLS keys used to carry information around during rendering.
378 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
379 thread_local!(pub static CURRENT_LOCATION_KEY: RefCell<Vec<String>> =
380 RefCell::new(Vec::new()));
381 thread_local!(static USED_ID_MAP: RefCell<FxHashMap<String, usize>> =
382 RefCell::new(init_ids()));
384 fn init_ids() -> FxHashMap<String, usize> {
400 ].into_iter().map(|id| (String::from(*id), 1)).collect()
403 /// This method resets the local table of used ID attributes. This is typically
404 /// used at the beginning of rendering an entire HTML page to reset from the
405 /// previous state (if any).
406 pub fn reset_ids(embedded: bool) {
407 USED_ID_MAP.with(|s| {
408 *s.borrow_mut() = if embedded {
416 pub fn derive_id(candidate: String) -> String {
417 USED_ID_MAP.with(|map| {
418 let id = match map.borrow_mut().get_mut(&candidate) {
421 let id = format!("{}-{}", candidate, *a);
427 map.borrow_mut().insert(id.clone(), 1);
432 /// Generates the documentation for `crate` into the directory `dst`
433 pub fn run(mut krate: clean::Crate,
434 external_html: &ExternalHtml,
435 playground_url: Option<String>,
437 passes: FxHashSet<String>,
438 css_file_extension: Option<PathBuf>,
439 renderinfo: RenderInfo,
440 render_type: RenderType) -> Result<(), Error> {
441 let src_root = match krate.src.parent() {
442 Some(p) => p.to_path_buf(),
443 None => PathBuf::new(),
445 let mut scx = SharedContext {
448 include_sources: true,
449 local_sources: FxHashMap(),
450 issue_tracker_base_url: None,
451 layout: layout::Layout {
452 logo: "".to_string(),
453 favicon: "".to_string(),
454 external_html: external_html.clone(),
455 krate: krate.name.clone(),
457 css_file_extension: css_file_extension.clone(),
460 // If user passed in `--playground-url` arg, we fill in crate name here
461 if let Some(url) = playground_url {
462 markdown::PLAYGROUND.with(|slot| {
463 *slot.borrow_mut() = Some((Some(krate.name.clone()), url));
467 // Crawl the crate attributes looking for attributes which control how we're
468 // going to emit HTML
469 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
470 for attr in attrs.lists("doc") {
471 let name = attr.name().map(|s| s.as_str());
472 match (name.as_ref().map(|s| &s[..]), attr.value_str()) {
473 (Some("html_favicon_url"), Some(s)) => {
474 scx.layout.favicon = s.to_string();
476 (Some("html_logo_url"), Some(s)) => {
477 scx.layout.logo = s.to_string();
479 (Some("html_playground_url"), Some(s)) => {
480 markdown::PLAYGROUND.with(|slot| {
481 let name = krate.name.clone();
482 *slot.borrow_mut() = Some((Some(name), s.to_string()));
485 (Some("issue_tracker_base_url"), Some(s)) => {
486 scx.issue_tracker_base_url = Some(s.to_string());
488 (Some("html_no_source"), None) if attr.is_word() => {
489 scx.include_sources = false;
495 try_err!(fs::create_dir_all(&dst), &dst);
496 krate = render_sources(&dst, &mut scx, krate)?;
500 render_redirect_pages: false,
501 shared: Arc::new(scx),
502 render_type: render_type,
505 // Crawl the crate to build various caches used for the output
515 let external_paths = external_paths.into_iter()
516 .map(|(k, (v, t))| (k, (v, ItemType::from(t))))
519 let mut cache = Cache {
521 external_paths: external_paths,
523 implementors: FxHashMap(),
525 parent_stack: Vec::new(),
526 search_index: Vec::new(),
527 parent_is_trait_impl: false,
528 extern_locations: FxHashMap(),
529 primitive_locations: FxHashMap(),
531 access_levels: krate.access_levels.clone(),
532 orphan_impl_items: Vec::new(),
533 traits: mem::replace(&mut krate.external_traits, FxHashMap()),
534 deref_trait_did: deref_trait_did,
535 deref_mut_trait_did: deref_mut_trait_did,
536 owned_box_did: owned_box_did,
537 typarams: external_typarams,
540 // Cache where all our extern crates are located
541 for &(n, ref e) in &krate.externs {
542 let src_root = match Path::new(&e.src).parent() {
543 Some(p) => p.to_path_buf(),
544 None => PathBuf::new(),
546 cache.extern_locations.insert(n, (e.name.clone(), src_root,
547 extern_location(e, &cx.dst)));
549 let did = DefId { krate: n, index: CRATE_DEF_INDEX };
550 cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
553 // Cache where all known primitives have their documentation located.
555 // Favor linking to as local extern as possible, so iterate all crates in
556 // reverse topological order.
557 for &(_, ref e) in krate.externs.iter().rev() {
558 for &(def_id, prim, _) in &e.primitives {
559 cache.primitive_locations.insert(prim, def_id);
562 for &(def_id, prim, _) in &krate.primitives {
563 cache.primitive_locations.insert(prim, def_id);
566 cache.stack.push(krate.name.clone());
567 krate = cache.fold_crate(krate);
569 // Build our search index
570 let index = build_index(&krate, &mut cache);
572 // Freeze the cache now that the index has been built. Put an Arc into TLS
573 // for future parallelization opportunities
574 let cache = Arc::new(cache);
575 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
576 CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear());
578 write_shared(&cx, &krate, &*cache, index)?;
580 // And finally render the whole crate's documentation
584 /// Build the search index from the collected metadata
585 fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
586 let mut nodeid_to_pathid = FxHashMap();
587 let mut crate_items = Vec::with_capacity(cache.search_index.len());
588 let mut crate_paths = Vec::<Json>::new();
590 let Cache { ref mut search_index,
591 ref orphan_impl_items,
592 ref mut paths, .. } = *cache;
594 // Attach all orphan items to the type's definition if the type
595 // has since been learned.
596 for &(did, ref item) in orphan_impl_items {
597 if let Some(&(ref fqp, _)) = paths.get(&did) {
598 search_index.push(IndexItem {
600 name: item.name.clone().unwrap(),
601 path: fqp[..fqp.len() - 1].join("::"),
602 desc: plain_summary_line(item.doc_value()),
605 search_type: get_index_search_type(&item),
610 // Reduce `NodeId` in paths into smaller sequential numbers,
611 // and prune the paths that do not appear in the index.
612 let mut lastpath = String::new();
613 let mut lastpathid = 0usize;
615 for item in search_index {
616 item.parent_idx = item.parent.map(|nodeid| {
617 if nodeid_to_pathid.contains_key(&nodeid) {
618 *nodeid_to_pathid.get(&nodeid).unwrap()
620 let pathid = lastpathid;
621 nodeid_to_pathid.insert(nodeid, pathid);
624 let &(ref fqp, short) = paths.get(&nodeid).unwrap();
625 crate_paths.push(((short as usize), fqp.last().unwrap().clone()).to_json());
630 // Omit the parent path if it is same to that of the prior item.
631 if lastpath == item.path {
634 lastpath = item.path.clone();
636 crate_items.push(item.to_json());
639 let crate_doc = krate.module.as_ref().map(|module| {
640 plain_summary_line(module.doc_value())
641 }).unwrap_or(String::new());
643 let mut crate_data = BTreeMap::new();
644 crate_data.insert("doc".to_owned(), Json::String(crate_doc));
645 crate_data.insert("items".to_owned(), Json::Array(crate_items));
646 crate_data.insert("paths".to_owned(), Json::Array(crate_paths));
648 // Collect the index into a string
649 format!("searchIndex[{}] = {};",
650 as_json(&krate.name),
651 Json::Object(crate_data))
654 fn write_shared(cx: &Context,
655 krate: &clean::Crate,
657 search_index: String) -> Result<(), Error> {
658 // Write out the shared files. Note that these are shared among all rustdoc
659 // docs placed in the output directory, so this needs to be a synchronized
660 // operation with respect to all other rustdocs running around.
661 try_err!(fs::create_dir_all(&cx.dst), &cx.dst);
662 let _lock = flock::Lock::panicking_new(&cx.dst.join(".lock"), true, true, true);
664 // Add all the static files. These may already exist, but we just
665 // overwrite them anyway to make sure that they're fresh and up-to-date.
667 write(cx.dst.join("main.js"),
668 include_bytes!("static/main.js"))?;
669 write(cx.dst.join("rustdoc.css"),
670 include_bytes!("static/rustdoc.css"))?;
671 write(cx.dst.join("main.css"),
672 include_bytes!("static/styles/main.css"))?;
673 if let Some(ref css) = cx.shared.css_file_extension {
674 let mut content = String::new();
675 let css = css.as_path();
676 let mut f = try_err!(File::open(css), css);
678 try_err!(f.read_to_string(&mut content), css);
679 let css = cx.dst.join("theme.css");
680 let css = css.as_path();
681 let mut f = try_err!(File::create(css), css);
682 try_err!(write!(f, "{}", &content), css);
684 write(cx.dst.join("normalize.css"),
685 include_bytes!("static/normalize.css"))?;
686 write(cx.dst.join("FiraSans-Regular.woff"),
687 include_bytes!("static/FiraSans-Regular.woff"))?;
688 write(cx.dst.join("FiraSans-Medium.woff"),
689 include_bytes!("static/FiraSans-Medium.woff"))?;
690 write(cx.dst.join("FiraSans-LICENSE.txt"),
691 include_bytes!("static/FiraSans-LICENSE.txt"))?;
692 write(cx.dst.join("Heuristica-Italic.woff"),
693 include_bytes!("static/Heuristica-Italic.woff"))?;
694 write(cx.dst.join("Heuristica-LICENSE.txt"),
695 include_bytes!("static/Heuristica-LICENSE.txt"))?;
696 write(cx.dst.join("SourceSerifPro-Regular.woff"),
697 include_bytes!("static/SourceSerifPro-Regular.woff"))?;
698 write(cx.dst.join("SourceSerifPro-Bold.woff"),
699 include_bytes!("static/SourceSerifPro-Bold.woff"))?;
700 write(cx.dst.join("SourceSerifPro-LICENSE.txt"),
701 include_bytes!("static/SourceSerifPro-LICENSE.txt"))?;
702 write(cx.dst.join("SourceCodePro-Regular.woff"),
703 include_bytes!("static/SourceCodePro-Regular.woff"))?;
704 write(cx.dst.join("SourceCodePro-Semibold.woff"),
705 include_bytes!("static/SourceCodePro-Semibold.woff"))?;
706 write(cx.dst.join("SourceCodePro-LICENSE.txt"),
707 include_bytes!("static/SourceCodePro-LICENSE.txt"))?;
708 write(cx.dst.join("LICENSE-MIT.txt"),
709 include_bytes!("static/LICENSE-MIT.txt"))?;
710 write(cx.dst.join("LICENSE-APACHE.txt"),
711 include_bytes!("static/LICENSE-APACHE.txt"))?;
712 write(cx.dst.join("COPYRIGHT.txt"),
713 include_bytes!("static/COPYRIGHT.txt"))?;
715 fn collect(path: &Path, krate: &str,
716 key: &str) -> io::Result<Vec<String>> {
717 let mut ret = Vec::new();
719 for line in BufReader::new(File::open(path)?).lines() {
721 if !line.starts_with(key) {
724 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
727 ret.push(line.to_string());
733 // Update the search index
734 let dst = cx.dst.join("search-index.js");
735 let mut all_indexes = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
736 all_indexes.push(search_index);
737 // Sort the indexes by crate so the file will be generated identically even
738 // with rustdoc running in parallel.
740 let mut w = try_err!(File::create(&dst), &dst);
741 try_err!(writeln!(&mut w, "var searchIndex = {{}};"), &dst);
742 for index in &all_indexes {
743 try_err!(writeln!(&mut w, "{}", *index), &dst);
745 try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst);
747 // Update the list of all implementors for traits
748 let dst = cx.dst.join("implementors");
749 for (&did, imps) in &cache.implementors {
750 // Private modules can leak through to this phase of rustdoc, which
751 // could contain implementations for otherwise private types. In some
752 // rare cases we could find an implementation for an item which wasn't
753 // indexed, so we just skip this step in that case.
755 // FIXME: this is a vague explanation for why this can't be a `get`, in
756 // theory it should be...
757 let &(ref remote_path, remote_item_type) = match cache.paths.get(&did) {
759 None => match cache.external_paths.get(&did) {
765 let mut have_impls = false;
766 let mut implementors = format!(r#"implementors["{}"] = ["#, krate.name);
768 // If the trait and implementation are in the same crate, then
769 // there's no need to emit information about it (there's inlining
770 // going on). If they're in different crates then the crate defining
771 // the trait will be interested in our implementation.
772 if imp.def_id.krate == did.krate { continue }
773 // If the implementation is from another crate then that crate
775 if !imp.def_id.is_local() { continue }
777 write!(implementors, "{},", as_json(&imp.impl_.to_string())).unwrap();
779 implementors.push_str("];");
781 // Only create a js file if we have impls to add to it. If the trait is
782 // documented locally though we always create the file to avoid dead
784 if !have_impls && !cache.paths.contains_key(&did) {
788 let mut mydst = dst.clone();
789 for part in &remote_path[..remote_path.len() - 1] {
792 try_err!(fs::create_dir_all(&mydst), &mydst);
793 mydst.push(&format!("{}.{}.js",
794 remote_item_type.css_class(),
795 remote_path[remote_path.len() - 1]));
797 let mut all_implementors = try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
798 all_implementors.push(implementors);
799 // Sort the implementors by crate so the file will be generated
800 // identically even with rustdoc running in parallel.
801 all_implementors.sort();
803 let mut f = try_err!(File::create(&mydst), &mydst);
804 try_err!(writeln!(&mut f, "(function() {{var implementors = {{}};"), &mydst);
805 for implementor in &all_implementors {
806 try_err!(writeln!(&mut f, "{}", *implementor), &mydst);
808 try_err!(writeln!(&mut f, "{}", r"
809 if (window.register_implementors) {
810 window.register_implementors(implementors);
812 window.pending_implementors = implementors;
815 try_err!(writeln!(&mut f, r"}})()"), &mydst);
820 fn render_sources(dst: &Path, scx: &mut SharedContext,
821 krate: clean::Crate) -> Result<clean::Crate, Error> {
822 info!("emitting source files");
823 let dst = dst.join("src").join(&krate.name);
824 try_err!(fs::create_dir_all(&dst), &dst);
825 let mut folder = SourceCollector {
829 Ok(folder.fold_crate(krate))
832 /// Writes the entire contents of a string to a destination, not attempting to
833 /// catch any errors.
834 fn write(dst: PathBuf, contents: &[u8]) -> Result<(), Error> {
835 Ok(try_err!(try_err!(File::create(&dst), &dst).write_all(contents), &dst))
838 /// Takes a path to a source file and cleans the path to it. This canonicalizes
839 /// things like ".." to components which preserve the "top down" hierarchy of a
840 /// static HTML tree. Each component in the cleaned path will be passed as an
841 /// argument to `f`. The very last component of the path (ie the file name) will
842 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
843 // FIXME (#9639): The closure should deal with &[u8] instead of &str
844 // FIXME (#9639): This is too conservative, rejecting non-UTF-8 paths
845 fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) where
848 // make it relative, if possible
849 let p = p.strip_prefix(src_root).unwrap_or(p);
851 let mut iter = p.components().peekable();
853 while let Some(c) = iter.next() {
854 if !keep_filename && iter.peek().is_none() {
859 Component::ParentDir => f("up"),
860 Component::Normal(c) => f(c.to_str().unwrap()),
866 /// Attempts to find where an external crate is located, given that we're
867 /// rendering in to the specified source destination.
868 fn extern_location(e: &clean::ExternalCrate, dst: &Path) -> ExternalLocation {
869 // See if there's documentation generated into the local directory
870 let local_location = dst.join(&e.name);
871 if local_location.is_dir() {
875 // Failing that, see if there's an attribute specifying where to find this
878 .filter(|a| a.check_name("html_root_url"))
879 .filter_map(|a| a.value_str())
881 let mut url = url.to_string();
882 if !url.ends_with("/") {
886 }).next().unwrap_or(Unknown) // Well, at least we tried.
889 impl<'a> DocFolder for SourceCollector<'a> {
890 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
891 // If we're including source files, and we haven't seen this file yet,
892 // then we need to render it out to the filesystem.
893 if self.scx.include_sources
894 // skip all invalid spans
895 && item.source.filename != ""
896 // skip non-local items
897 && item.def_id.is_local()
898 // Macros from other libraries get special filenames which we can
900 && !(item.source.filename.starts_with("<")
901 && item.source.filename.ends_with("macros>")) {
903 // If it turns out that we couldn't read this file, then we probably
904 // can't read any of the files (generating html output from json or
905 // something like that), so just don't include sources for the
906 // entire crate. The other option is maintaining this mapping on a
907 // per-file basis, but that's probably not worth it...
909 .include_sources = match self.emit_source(&item.source.filename) {
912 println!("warning: source code was requested to be rendered, \
913 but processing `{}` had an error: {}",
914 item.source.filename, e);
915 println!(" skipping rendering of source code");
920 self.fold_item_recur(item)
924 impl<'a> SourceCollector<'a> {
925 /// Renders the given filename into its corresponding HTML source file.
926 fn emit_source(&mut self, filename: &str) -> io::Result<()> {
927 let p = PathBuf::from(filename);
928 if self.scx.local_sources.contains_key(&p) {
929 // We've already emitted this source
933 let mut contents = Vec::new();
934 File::open(&p).and_then(|mut f| f.read_to_end(&mut contents))?;
936 let contents = str::from_utf8(&contents).unwrap();
938 // Remove the utf-8 BOM if any
939 let contents = if contents.starts_with("\u{feff}") {
945 // Create the intermediate directories
946 let mut cur = self.dst.clone();
947 let mut root_path = String::from("../../");
948 let mut href = String::new();
949 clean_srcpath(&self.scx.src_root, &p, false, |component| {
951 fs::create_dir_all(&cur).unwrap();
952 root_path.push_str("../");
953 href.push_str(component);
956 let mut fname = p.file_name().expect("source has no filename")
960 href.push_str(&fname.to_string_lossy());
962 let mut w = BufWriter::new(File::create(&cur)?);
963 let title = format!("{} -- source", cur.file_name().unwrap()
965 let desc = format!("Source to the Rust file `{}`.", filename);
966 let page = layout::Page {
969 root_path: &root_path,
971 keywords: BASIC_KEYWORDS,
973 layout::render(&mut w, &self.scx.layout,
974 &page, &(""), &Source(contents),
975 self.scx.css_file_extension.is_some())?;
977 self.scx.local_sources.insert(p, href);
982 impl DocFolder for Cache {
983 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
984 // If this is a stripped module,
985 // we don't want it or its children in the search index.
986 let orig_stripped_mod = match item.inner {
987 clean::StrippedItem(box clean::ModuleItem(..)) => {
988 mem::replace(&mut self.stripped_mod, true)
990 _ => self.stripped_mod,
993 // Register any generics to their corresponding string. This is used
994 // when pretty-printing types.
995 if let Some(generics) = item.inner.generics() {
996 self.generics(generics);
999 // Propagate a trait method's documentation to all implementors of the
1001 if let clean::TraitItem(ref t) = item.inner {
1002 self.traits.entry(item.def_id).or_insert_with(|| t.clone());
1005 // Collect all the implementors of traits.
1006 if let clean::ImplItem(ref i) = item.inner {
1007 if let Some(did) = i.trait_.def_id() {
1008 self.implementors.entry(did).or_insert(vec![]).push(Implementor {
1009 def_id: item.def_id,
1010 stability: item.stability.clone(),
1016 // Index this method for searching later on.
1017 if let Some(ref s) = item.name {
1018 let (parent, is_inherent_impl_item) = match item.inner {
1019 clean::StrippedItem(..) => ((None, None), false),
1020 clean::AssociatedConstItem(..) |
1021 clean::TypedefItem(_, true) if self.parent_is_trait_impl => {
1022 // skip associated items in trait impls
1023 ((None, None), false)
1025 clean::AssociatedTypeItem(..) |
1026 clean::TyMethodItem(..) |
1027 clean::StructFieldItem(..) |
1028 clean::VariantItem(..) => {
1029 ((Some(*self.parent_stack.last().unwrap()),
1030 Some(&self.stack[..self.stack.len() - 1])),
1033 clean::MethodItem(..) | clean::AssociatedConstItem(..) => {
1034 if self.parent_stack.is_empty() {
1035 ((None, None), false)
1037 let last = self.parent_stack.last().unwrap();
1039 let path = match self.paths.get(&did) {
1040 // The current stack not necessarily has correlation
1041 // for where the type was defined. On the other
1042 // hand, `paths` always has the right
1043 // information if present.
1044 Some(&(ref fqp, ItemType::Trait)) |
1045 Some(&(ref fqp, ItemType::Struct)) |
1046 Some(&(ref fqp, ItemType::Union)) |
1047 Some(&(ref fqp, ItemType::Enum)) =>
1048 Some(&fqp[..fqp.len() - 1]),
1049 Some(..) => Some(&*self.stack),
1052 ((Some(*last), path), true)
1055 _ => ((None, Some(&*self.stack)), false)
1059 (parent, Some(path)) if is_inherent_impl_item || (!self.stripped_mod) => {
1060 debug_assert!(!item.is_stripped());
1062 // A crate has a module at its root, containing all items,
1063 // which should not be indexed. The crate-item itself is
1064 // inserted later on when serializing the search-index.
1065 if item.def_id.index != CRATE_DEF_INDEX {
1066 self.search_index.push(IndexItem {
1068 name: s.to_string(),
1069 path: path.join("::").to_string(),
1070 desc: plain_summary_line(item.doc_value()),
1073 search_type: get_index_search_type(&item),
1077 (Some(parent), None) if is_inherent_impl_item => {
1078 // We have a parent, but we don't know where they're
1079 // defined yet. Wait for later to index this item.
1080 self.orphan_impl_items.push((parent, item.clone()));
1086 // Keep track of the fully qualified path for this item.
1087 let pushed = match item.name {
1088 Some(ref n) if !n.is_empty() => {
1089 self.stack.push(n.to_string());
1096 clean::StructItem(..) | clean::EnumItem(..) |
1097 clean::TypedefItem(..) | clean::TraitItem(..) |
1098 clean::FunctionItem(..) | clean::ModuleItem(..) |
1099 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
1100 clean::ConstantItem(..) | clean::StaticItem(..) |
1101 clean::UnionItem(..)
1102 if !self.stripped_mod => {
1103 // Reexported items mean that the same id can show up twice
1104 // in the rustdoc ast that we're looking at. We know,
1105 // however, that a reexported item doesn't show up in the
1106 // `public_items` map, so we can skip inserting into the
1107 // paths map if there was already an entry present and we're
1108 // not a public item.
1110 !self.paths.contains_key(&item.def_id) ||
1111 self.access_levels.is_public(item.def_id)
1113 self.paths.insert(item.def_id,
1114 (self.stack.clone(), item.type_()));
1117 // Link variants to their parent enum because pages aren't emitted
1118 // for each variant.
1119 clean::VariantItem(..) if !self.stripped_mod => {
1120 let mut stack = self.stack.clone();
1122 self.paths.insert(item.def_id, (stack, ItemType::Enum));
1125 clean::PrimitiveItem(..) if item.visibility.is_some() => {
1126 self.paths.insert(item.def_id, (self.stack.clone(),
1133 // Maintain the parent stack
1134 let orig_parent_is_trait_impl = self.parent_is_trait_impl;
1135 let parent_pushed = match item.inner {
1136 clean::TraitItem(..) | clean::EnumItem(..) |
1137 clean::StructItem(..) | clean::UnionItem(..) => {
1138 self.parent_stack.push(item.def_id);
1139 self.parent_is_trait_impl = false;
1142 clean::ImplItem(ref i) => {
1143 self.parent_is_trait_impl = i.trait_.is_some();
1145 clean::ResolvedPath{ did, .. } => {
1146 self.parent_stack.push(did);
1150 let prim_did = t.primitive_type().and_then(|t| {
1151 self.primitive_locations.get(&t).cloned()
1155 self.parent_stack.push(did);
1166 // Once we've recursively found all the generics, hoard off all the
1167 // implementations elsewhere.
1168 let ret = self.fold_item_recur(item).and_then(|item| {
1169 if let clean::Item { inner: clean::ImplItem(_), .. } = item {
1170 // Figure out the id of this impl. This may map to a
1171 // primitive rather than always to a struct/enum.
1172 // Note: matching twice to restrict the lifetime of the `i` borrow.
1173 let did = if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
1175 clean::ResolvedPath { did, .. } |
1176 clean::BorrowedRef {
1177 type_: box clean::ResolvedPath { did, .. }, ..
1182 t.primitive_type().and_then(|t| {
1183 self.primitive_locations.get(&t).cloned()
1190 if let Some(did) = did {
1191 self.impls.entry(did).or_insert(vec![]).push(Impl {
1201 if pushed { self.stack.pop().unwrap(); }
1202 if parent_pushed { self.parent_stack.pop().unwrap(); }
1203 self.stripped_mod = orig_stripped_mod;
1204 self.parent_is_trait_impl = orig_parent_is_trait_impl;
1210 fn generics(&mut self, generics: &clean::Generics) {
1211 for typ in &generics.type_params {
1212 self.typarams.insert(typ.did, typ.name.clone());
1218 /// String representation of how to get back to the root path of the 'doc/'
1219 /// folder in terms of a relative URL.
1220 fn root_path(&self) -> String {
1221 repeat("../").take(self.current.len()).collect::<String>()
1224 /// Recurse in the directory structure and change the "root path" to make
1225 /// sure it always points to the top (relatively).
1226 fn recurse<T, F>(&mut self, s: String, f: F) -> T where
1227 F: FnOnce(&mut Context) -> T,
1230 panic!("Unexpected empty destination: {:?}", self.current);
1232 let prev = self.dst.clone();
1234 self.current.push(s);
1236 info!("Recursing into {}", self.dst.display());
1240 info!("Recursed; leaving {}", self.dst.display());
1242 // Go back to where we were at
1244 self.current.pop().unwrap();
1249 /// Main method for rendering a crate.
1251 /// This currently isn't parallelized, but it'd be pretty easy to add
1252 /// parallelization to this function.
1253 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1254 let mut item = match krate.module.take() {
1256 None => return Ok(()),
1258 item.name = Some(krate.name);
1260 // Render the crate documentation
1261 let mut work = vec![(self, item)];
1263 while let Some((mut cx, item)) = work.pop() {
1264 cx.item(item, |cx, item| {
1265 work.push((cx.clone(), item))
1271 fn render_item(&self,
1272 writer: &mut io::Write,
1276 // A little unfortunate that this is done like this, but it sure
1277 // does make formatting *a lot* nicer.
1278 CURRENT_LOCATION_KEY.with(|slot| {
1279 *slot.borrow_mut() = self.current.clone();
1282 let mut title = if it.is_primitive() {
1283 // No need to include the namespace for primitive types
1286 self.current.join("::")
1289 if !title.is_empty() {
1290 title.push_str("::");
1292 title.push_str(it.name.as_ref().unwrap());
1294 title.push_str(" - Rust");
1295 let tyname = it.type_().css_class();
1296 let desc = if it.is_crate() {
1297 format!("API documentation for the Rust `{}` crate.",
1298 self.shared.layout.krate)
1300 format!("API documentation for the Rust `{}` {} in crate `{}`.",
1301 it.name.as_ref().unwrap(), tyname, self.shared.layout.krate)
1303 let keywords = make_item_keywords(it);
1304 let page = layout::Page {
1306 root_path: &self.root_path(),
1309 keywords: &keywords,
1314 if !self.render_redirect_pages {
1315 layout::render(writer, &self.shared.layout, &page,
1316 &Sidebar{ cx: self, item: it },
1317 &Item{ cx: self, item: it },
1318 self.shared.css_file_extension.is_some())?;
1320 let mut url = self.root_path();
1321 if let Some(&(ref names, ty)) = cache().paths.get(&it.def_id) {
1322 for name in &names[..names.len() - 1] {
1326 url.push_str(&item_path(ty, names.last().unwrap()));
1327 layout::redirect(writer, &url)?;
1333 /// Non-parallelized version of rendering an item. This will take the input
1334 /// item, render its contents, and then invoke the specified closure with
1335 /// all sub-items which need to be rendered.
1337 /// The rendering driver uses this closure to queue up more work.
1338 fn item<F>(&mut self, item: clean::Item, mut f: F) -> Result<(), Error> where
1339 F: FnMut(&mut Context, clean::Item),
1341 // Stripped modules survive the rustdoc passes (i.e. `strip-private`)
1342 // if they contain impls for public types. These modules can also
1343 // contain items such as publicly reexported structures.
1345 // External crates will provide links to these structures, so
1346 // these modules are recursed into, but not rendered normally
1347 // (a flag on the context).
1348 if !self.render_redirect_pages {
1349 self.render_redirect_pages = item.is_stripped();
1353 // modules are special because they add a namespace. We also need to
1354 // recurse into the items of the module as well.
1355 let name = item.name.as_ref().unwrap().to_string();
1356 let mut item = Some(item);
1357 self.recurse(name, |this| {
1358 let item = item.take().unwrap();
1360 let mut buf = Vec::new();
1361 this.render_item(&mut buf, &item, false).unwrap();
1362 // buf will be empty if the module is stripped and there is no redirect for it
1363 if !buf.is_empty() {
1364 let joint_dst = this.dst.join("index.html");
1365 try_err!(fs::create_dir_all(&this.dst), &this.dst);
1366 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1367 try_err!(dst.write_all(&buf), &joint_dst);
1370 let m = match item.inner {
1371 clean::StrippedItem(box clean::ModuleItem(m)) |
1372 clean::ModuleItem(m) => m,
1376 // Render sidebar-items.js used throughout this module.
1377 if !this.render_redirect_pages {
1378 let items = this.build_sidebar_items(&m);
1379 let js_dst = this.dst.join("sidebar-items.js");
1380 let mut js_out = BufWriter::new(try_err!(File::create(&js_dst), &js_dst));
1381 try_err!(write!(&mut js_out, "initSidebarItems({});",
1382 as_json(&items)), &js_dst);
1385 for item in m.items {
1391 } else if item.name.is_some() {
1392 let mut buf = Vec::new();
1393 self.render_item(&mut buf, &item, true).unwrap();
1394 // buf will be empty if the item is stripped and there is no redirect for it
1395 if !buf.is_empty() {
1396 let name = item.name.as_ref().unwrap();
1397 let item_type = item.type_();
1398 let file_name = &item_path(item_type, name);
1399 let joint_dst = self.dst.join(file_name);
1400 try_err!(fs::create_dir_all(&self.dst), &self.dst);
1401 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1402 try_err!(dst.write_all(&buf), &joint_dst);
1404 // Redirect from a sane URL using the namespace to Rustdoc's
1405 // URL for the page.
1406 let redir_name = format!("{}.{}.html", name, item_type.name_space());
1407 let redir_dst = self.dst.join(redir_name);
1408 if let Ok(mut redirect_out) = OpenOptions::new().create_new(true)
1411 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1414 // If the item is a macro, redirect from the old macro URL (with !)
1415 // to the new one (without).
1416 // FIXME(#35705) remove this redirect.
1417 if item_type == ItemType::Macro {
1418 let redir_name = format!("{}.{}!.html", item_type, name);
1419 let redir_dst = self.dst.join(redir_name);
1420 let mut redirect_out = try_err!(File::create(&redir_dst), &redir_dst);
1421 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1428 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
1429 // BTreeMap instead of HashMap to get a sorted output
1430 let mut map = BTreeMap::new();
1431 for item in &m.items {
1432 if item.is_stripped() { continue }
1434 let short = item.type_().css_class();
1435 let myname = match item.name {
1437 Some(ref s) => s.to_string(),
1439 let short = short.to_string();
1440 map.entry(short).or_insert(vec![])
1441 .push((myname, Some(plain_summary_line(item.doc_value()))));
1444 for (_, items) in &mut map {
1452 /// Generate a url appropriate for an `href` attribute back to the source of
1455 /// The url generated, when clicked, will redirect the browser back to the
1456 /// original source code.
1458 /// If `None` is returned, then a source link couldn't be generated. This
1459 /// may happen, for example, with externally inlined items where the source
1460 /// of their crate documentation isn't known.
1461 fn src_href(&self) -> Option<String> {
1462 let mut root = self.cx.root_path();
1464 let cache = cache();
1465 let mut path = String::new();
1466 let (krate, path) = if self.item.def_id.is_local() {
1467 let path = PathBuf::from(&self.item.source.filename);
1468 if let Some(path) = self.cx.shared.local_sources.get(&path) {
1469 (&self.cx.shared.layout.krate, path)
1474 // Macros from other libraries get special filenames which we can
1476 if self.item.source.filename.starts_with("<") &&
1477 self.item.source.filename.ends_with("macros>") {
1481 let (krate, src_root) = match cache.extern_locations.get(&self.item.def_id.krate) {
1482 Some(&(ref name, ref src, Local)) => (name, src),
1483 Some(&(ref name, ref src, Remote(ref s))) => {
1484 root = s.to_string();
1487 Some(&(_, _, Unknown)) | None => return None,
1490 let file = Path::new(&self.item.source.filename);
1491 clean_srcpath(&src_root, file, false, |component| {
1492 path.push_str(component);
1495 let mut fname = file.file_name().expect("source has no filename")
1497 fname.push(".html");
1498 path.push_str(&fname.to_string_lossy());
1502 let lines = if self.item.source.loline == self.item.source.hiline {
1503 format!("{}", self.item.source.loline)
1505 format!("{}-{}", self.item.source.loline, self.item.source.hiline)
1507 Some(format!("{root}src/{krate}/{path}#{lines}",
1515 impl<'a> fmt::Display for Item<'a> {
1516 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1517 debug_assert!(!self.item.is_stripped());
1518 // Write the breadcrumb trail header for the top
1519 write!(fmt, "\n<h1 class='fqn'><span class='in-band'>")?;
1520 match self.item.inner {
1521 clean::ModuleItem(ref m) => if m.is_crate {
1522 write!(fmt, "Crate ")?;
1524 write!(fmt, "Module ")?;
1526 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) =>
1527 write!(fmt, "Function ")?,
1528 clean::TraitItem(..) => write!(fmt, "Trait ")?,
1529 clean::StructItem(..) => write!(fmt, "Struct ")?,
1530 clean::UnionItem(..) => write!(fmt, "Union ")?,
1531 clean::EnumItem(..) => write!(fmt, "Enum ")?,
1532 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
1533 clean::MacroItem(..) => write!(fmt, "Macro ")?,
1534 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
1535 clean::StaticItem(..) | clean::ForeignStaticItem(..) =>
1536 write!(fmt, "Static ")?,
1537 clean::ConstantItem(..) => write!(fmt, "Constant ")?,
1539 // We don't generate pages for any other type.
1543 if !self.item.is_primitive() {
1544 let cur = &self.cx.current;
1545 let amt = if self.item.is_mod() { cur.len() - 1 } else { cur.len() };
1546 for (i, component) in cur.iter().enumerate().take(amt) {
1547 write!(fmt, "<a href='{}index.html'>{}</a>::<wbr>",
1548 repeat("../").take(cur.len() - i - 1)
1549 .collect::<String>(),
1553 write!(fmt, "<a class=\"{}\" href=''>{}</a>",
1554 self.item.type_(), self.item.name.as_ref().unwrap())?;
1556 write!(fmt, "</span>")?; // in-band
1557 write!(fmt, "<span class='out-of-band'>")?;
1558 if let Some(version) = self.item.stable_since() {
1559 write!(fmt, "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
1563 r##"<span id='render-detail'>
1564 <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
1565 [<span class='inner'>−</span>]
1571 // When this item is part of a `pub use` in a downstream crate, the
1572 // [src] link in the downstream documentation will actually come back to
1573 // this page, and this link will be auto-clicked. The `id` attribute is
1574 // used to find the link to auto-click.
1575 if self.cx.shared.include_sources && !self.item.is_primitive() {
1576 if let Some(l) = self.src_href() {
1577 write!(fmt, "<a class='srclink' href='{}' title='{}'>[src]</a>",
1578 l, "goto source code")?;
1582 write!(fmt, "</span>")?; // out-of-band
1584 write!(fmt, "</h1>\n")?;
1586 match self.item.inner {
1587 clean::ModuleItem(ref m) => {
1588 item_module(fmt, self.cx, self.item, &m.items)
1590 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) =>
1591 item_function(fmt, self.cx, self.item, f),
1592 clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t),
1593 clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s),
1594 clean::UnionItem(ref s) => item_union(fmt, self.cx, self.item, s),
1595 clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e),
1596 clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t),
1597 clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m),
1598 clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p),
1599 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) =>
1600 item_static(fmt, self.cx, self.item, i),
1601 clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c),
1603 // We don't generate pages for any other type.
1610 fn item_path(ty: ItemType, name: &str) -> String {
1612 ItemType::Module => format!("{}/index.html", name),
1613 _ => format!("{}.{}.html", ty.css_class(), name),
1617 fn full_path(cx: &Context, item: &clean::Item) -> String {
1618 let mut s = cx.current.join("::");
1620 s.push_str(item.name.as_ref().unwrap());
1624 fn shorter<'a>(s: Option<&'a str>) -> String {
1626 Some(s) => s.lines().take_while(|line|{
1627 (*line).chars().any(|chr|{
1628 !chr.is_whitespace()
1630 }).collect::<Vec<_>>().join("\n"),
1631 None => "".to_string()
1636 fn plain_summary_line(s: Option<&str>) -> String {
1637 let line = shorter(s).replace("\n", " ");
1638 markdown::plain_summary_line(&line[..])
1641 fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1642 document_stability(w, cx, item)?;
1643 let prefix = render_assoc_const_value(item);
1644 document_full(w, item, cx.render_type, &prefix)?;
1648 fn document_short(w: &mut fmt::Formatter, item: &clean::Item, link: AssocItemLink,
1649 render_type: RenderType, prefix: &str) -> fmt::Result {
1650 if let Some(s) = item.doc_value() {
1651 let markdown = if s.contains('\n') {
1652 format!("{} [Read more]({})",
1653 &plain_summary_line(Some(s)), naive_assoc_href(item, link))
1655 format!("{}", &plain_summary_line(Some(s)))
1657 write!(w, "<div class='docblock'>{}{}</div>", prefix, Markdown(&markdown, render_type))?;
1658 } else if !prefix.is_empty() {
1659 write!(w, "<div class='docblock'>{}</div>", prefix)?;
1664 fn render_assoc_const_value(item: &clean::Item) -> String {
1666 clean::AssociatedConstItem(ref ty, Some(ref default)) => {
1667 highlight::render_with_highlighting(
1668 &format!("{}: {:#} = {}", item.name.as_ref().unwrap(), ty, default),
1678 fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
1679 render_type: RenderType, prefix: &str) -> fmt::Result {
1680 if let Some(s) = item.doc_value() {
1681 write!(w, "<div class='docblock'>{}{}</div>", prefix, Markdown(s, render_type))?;
1682 } else if !prefix.is_empty() {
1683 write!(w, "<div class='docblock'>{}</div>", prefix)?;
1688 fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1689 let stabilities = short_stability(item, cx, true);
1690 if !stabilities.is_empty() {
1691 write!(w, "<div class='stability'>")?;
1692 for stability in stabilities {
1693 write!(w, "{}", stability)?;
1695 write!(w, "</div>")?;
1700 fn name_key(name: &str) -> (&str, u64, usize) {
1701 // find number at end
1702 let split = name.bytes().rposition(|b| b < b'0' || b'9' < b).map_or(0, |s| s + 1);
1704 // count leading zeroes
1706 name[split..].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
1708 // sort leading zeroes last
1709 let num_zeroes = after_zeroes - split;
1711 match name[split..].parse() {
1712 Ok(n) => (&name[..split], n, num_zeroes),
1713 Err(_) => (name, 0, num_zeroes),
1717 fn item_module(w: &mut fmt::Formatter, cx: &Context,
1718 item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
1719 document(w, cx, item)?;
1721 let mut indices = (0..items.len()).filter(|i| {
1722 if let clean::DefaultImplItem(..) = items[*i].inner {
1725 !items[*i].is_stripped()
1726 }).collect::<Vec<usize>>();
1728 // the order of item types in the listing
1729 fn reorder(ty: ItemType) -> u8 {
1731 ItemType::ExternCrate => 0,
1732 ItemType::Import => 1,
1733 ItemType::Primitive => 2,
1734 ItemType::Module => 3,
1735 ItemType::Macro => 4,
1736 ItemType::Struct => 5,
1737 ItemType::Enum => 6,
1738 ItemType::Constant => 7,
1739 ItemType::Static => 8,
1740 ItemType::Trait => 9,
1741 ItemType::Function => 10,
1742 ItemType::Typedef => 12,
1743 ItemType::Union => 13,
1748 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
1749 let ty1 = i1.type_();
1750 let ty2 = i2.type_();
1752 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2))
1754 let s1 = i1.stability.as_ref().map(|s| s.level);
1755 let s2 = i2.stability.as_ref().map(|s| s.level);
1757 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
1758 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
1761 let lhs = i1.name.as_ref().map_or("", |s| &**s);
1762 let rhs = i2.name.as_ref().map_or("", |s| &**s);
1763 name_key(lhs).cmp(&name_key(rhs))
1766 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
1768 debug!("{:?}", indices);
1769 let mut curty = None;
1770 for &idx in &indices {
1771 let myitem = &items[idx];
1772 if myitem.is_stripped() {
1776 let myty = Some(myitem.type_());
1777 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
1778 // Put `extern crate` and `use` re-exports in the same section.
1780 } else if myty != curty {
1781 if curty.is_some() {
1782 write!(w, "</table>")?;
1785 let (short, name) = match myty.unwrap() {
1786 ItemType::ExternCrate |
1787 ItemType::Import => ("reexports", "Reexports"),
1788 ItemType::Module => ("modules", "Modules"),
1789 ItemType::Struct => ("structs", "Structs"),
1790 ItemType::Union => ("unions", "Unions"),
1791 ItemType::Enum => ("enums", "Enums"),
1792 ItemType::Function => ("functions", "Functions"),
1793 ItemType::Typedef => ("types", "Type Definitions"),
1794 ItemType::Static => ("statics", "Statics"),
1795 ItemType::Constant => ("constants", "Constants"),
1796 ItemType::Trait => ("traits", "Traits"),
1797 ItemType::Impl => ("impls", "Implementations"),
1798 ItemType::TyMethod => ("tymethods", "Type Methods"),
1799 ItemType::Method => ("methods", "Methods"),
1800 ItemType::StructField => ("fields", "Struct Fields"),
1801 ItemType::Variant => ("variants", "Variants"),
1802 ItemType::Macro => ("macros", "Macros"),
1803 ItemType::Primitive => ("primitives", "Primitive Types"),
1804 ItemType::AssociatedType => ("associated-types", "Associated Types"),
1805 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
1807 write!(w, "<h2 id='{id}' class='section-header'>\
1808 <a href=\"#{id}\">{name}</a></h2>\n<table>",
1809 id = derive_id(short.to_owned()), name = name)?;
1812 match myitem.inner {
1813 clean::ExternCrateItem(ref name, ref src) => {
1814 use html::format::HRef;
1818 write!(w, "<tr><td><code>{}extern crate {} as {};",
1819 VisSpace(&myitem.visibility),
1820 HRef::new(myitem.def_id, src),
1824 write!(w, "<tr><td><code>{}extern crate {};",
1825 VisSpace(&myitem.visibility),
1826 HRef::new(myitem.def_id, name))?
1829 write!(w, "</code></td></tr>")?;
1832 clean::ImportItem(ref import) => {
1833 write!(w, "<tr><td><code>{}{}</code></td></tr>",
1834 VisSpace(&myitem.visibility), *import)?;
1838 if myitem.name.is_none() { continue }
1840 let stabilities = short_stability(myitem, cx, false);
1842 let stab_docs = if !stabilities.is_empty() {
1844 .map(|s| format!("[{}]", s))
1845 .collect::<Vec<_>>()
1852 let unsafety_flag = match myitem.inner {
1853 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
1854 if func.unsafety == hir::Unsafety::Unsafe => {
1855 "<a title='unsafe function' href='#'><sup>âš </sup></a>"
1860 let doc_value = myitem.doc_value().unwrap_or("");
1862 <tr class='{stab} module-item'>
1863 <td><a class=\"{class}\" href=\"{href}\"
1864 title='{title_type} {title}'>{name}</a>{unsafety_flag}</td>
1865 <td class='docblock-short'>
1869 name = *myitem.name.as_ref().unwrap(),
1870 stab_docs = stab_docs,
1871 docs = if cx.render_type == RenderType::Hoedown {
1873 shorter(Some(&Markdown(doc_value,
1874 RenderType::Hoedown).to_string())))
1876 format!("{}", MarkdownSummaryLine(doc_value))
1878 class = myitem.type_(),
1879 stab = myitem.stability_class().unwrap_or("".to_string()),
1880 unsafety_flag = unsafety_flag,
1881 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
1882 title_type = myitem.type_(),
1883 title = full_path(cx, myitem))?;
1888 if curty.is_some() {
1889 write!(w, "</table>")?;
1894 fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
1895 let mut stability = vec![];
1897 if let Some(stab) = item.stability.as_ref() {
1898 let deprecated_reason = if show_reason && !stab.deprecated_reason.is_empty() {
1899 format!(": {}", stab.deprecated_reason)
1903 if !stab.deprecated_since.is_empty() {
1904 let since = if show_reason {
1905 format!(" since {}", Escape(&stab.deprecated_since))
1909 let text = format!("Deprecated{}{}",
1911 MarkdownHtml(&deprecated_reason, cx.render_type));
1912 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1915 if stab.level == stability::Unstable {
1917 let unstable_extra = match (!stab.feature.is_empty(),
1918 &cx.shared.issue_tracker_base_url,
1920 (true, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1921 format!(" (<code>{} </code><a href=\"{}{}\">#{}</a>)",
1922 Escape(&stab.feature), tracker_url, issue_no, issue_no),
1923 (false, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1924 format!(" (<a href=\"{}{}\">#{}</a>)", Escape(&tracker_url), issue_no,
1927 format!(" (<code>{}</code>)", Escape(&stab.feature)),
1930 if stab.unstable_reason.is_empty() {
1931 stability.push(format!("<div class='stab unstable'>\
1932 <span class=microscope>🔬</span> \
1933 This is a nightly-only experimental API. {}\
1937 let text = format!("<summary><span class=microscope>🔬</span> \
1938 This is a nightly-only experimental API. {}\
1941 MarkdownHtml(&stab.unstable_reason, cx.render_type));
1942 stability.push(format!("<div class='stab unstable'><details>{}</details></div>",
1946 stability.push(format!("<div class='stab unstable'>Experimental</div>"))
1949 } else if let Some(depr) = item.deprecation.as_ref() {
1950 let note = if show_reason && !depr.note.is_empty() {
1951 format!(": {}", depr.note)
1955 let since = if show_reason && !depr.since.is_empty() {
1956 format!(" since {}", Escape(&depr.since))
1961 let text = format!("Deprecated{}{}", since, MarkdownHtml(¬e, cx.render_type));
1962 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1965 if let Some(ref cfg) = item.attrs.cfg {
1966 stability.push(format!("<div class='stab portability'>{}</div>", if show_reason {
1967 cfg.render_long_html()
1969 cfg.render_short_html()
1976 struct Initializer<'a>(&'a str);
1978 impl<'a> fmt::Display for Initializer<'a> {
1979 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1980 let Initializer(s) = *self;
1981 if s.is_empty() { return Ok(()); }
1982 write!(f, "<code> = </code>")?;
1983 write!(f, "<code>{}</code>", Escape(s))
1987 fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
1988 c: &clean::Constant) -> fmt::Result {
1989 write!(w, "<pre class='rust const'>")?;
1990 render_attributes(w, it)?;
1991 write!(w, "{vis}const \
1992 {name}: {typ}{init}</pre>",
1993 vis = VisSpace(&it.visibility),
1994 name = it.name.as_ref().unwrap(),
1996 init = Initializer(&c.expr))?;
2000 fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2001 s: &clean::Static) -> fmt::Result {
2002 write!(w, "<pre class='rust static'>")?;
2003 render_attributes(w, it)?;
2004 write!(w, "{vis}static {mutability}\
2005 {name}: {typ}{init}</pre>",
2006 vis = VisSpace(&it.visibility),
2007 mutability = MutableSpace(s.mutability),
2008 name = it.name.as_ref().unwrap(),
2010 init = Initializer(&s.expr))?;
2014 fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2015 f: &clean::Function) -> fmt::Result {
2016 // FIXME(#24111): remove when `const_fn` is stabilized
2017 let vis_constness = match UnstableFeatures::from_environment() {
2018 UnstableFeatures::Allow => f.constness,
2019 _ => hir::Constness::NotConst
2021 let name_len = format!("{}{}{}{:#}fn {}{:#}",
2022 VisSpace(&it.visibility),
2023 ConstnessSpace(vis_constness),
2024 UnsafetySpace(f.unsafety),
2026 it.name.as_ref().unwrap(),
2028 write!(w, "<pre class='rust fn'>")?;
2029 render_attributes(w, it)?;
2030 write!(w, "{vis}{constness}{unsafety}{abi}fn \
2031 {name}{generics}{decl}{where_clause}</pre>",
2032 vis = VisSpace(&it.visibility),
2033 constness = ConstnessSpace(vis_constness),
2034 unsafety = UnsafetySpace(f.unsafety),
2035 abi = AbiSpace(f.abi),
2036 name = it.name.as_ref().unwrap(),
2037 generics = f.generics,
2038 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2047 fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2048 t: &clean::Trait) -> fmt::Result {
2049 let mut bounds = String::new();
2050 let mut bounds_plain = String::new();
2051 if !t.bounds.is_empty() {
2052 if !bounds.is_empty() {
2054 bounds_plain.push(' ');
2056 bounds.push_str(": ");
2057 bounds_plain.push_str(": ");
2058 for (i, p) in t.bounds.iter().enumerate() {
2060 bounds.push_str(" + ");
2061 bounds_plain.push_str(" + ");
2063 bounds.push_str(&format!("{}", *p));
2064 bounds_plain.push_str(&format!("{:#}", *p));
2068 // Output the trait definition
2069 write!(w, "<pre class='rust trait'>")?;
2070 render_attributes(w, it)?;
2071 write!(w, "{}{}trait {}{}{}",
2072 VisSpace(&it.visibility),
2073 UnsafetySpace(t.unsafety),
2074 it.name.as_ref().unwrap(),
2078 if !t.generics.where_predicates.is_empty() {
2079 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true })?;
2084 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2085 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2086 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2087 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2089 if t.items.is_empty() {
2090 write!(w, "{{ }}")?;
2092 // FIXME: we should be using a derived_id for the Anchors here
2096 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2099 if !types.is_empty() && !consts.is_empty() {
2104 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2107 if !consts.is_empty() && !required.is_empty() {
2110 for (pos, m) in required.iter().enumerate() {
2112 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2115 if pos < required.len() - 1 {
2116 write!(w, "<div class='item-spacer'></div>")?;
2119 if !required.is_empty() && !provided.is_empty() {
2122 for (pos, m) in provided.iter().enumerate() {
2124 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2126 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2127 write!(w, ",\n {{ ... }}\n")?;
2130 write!(w, " {{ ... }}\n")?;
2133 if pos < provided.len() - 1 {
2134 write!(w, "<div class='item-spacer'></div>")?;
2139 write!(w, "</pre>")?;
2141 // Trait documentation
2142 document(w, cx, it)?;
2144 fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item, t: &clean::Item)
2146 let name = m.name.as_ref().unwrap();
2147 let item_type = m.type_();
2148 let id = derive_id(format!("{}.{}", item_type, name));
2149 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2150 write!(w, "<h3 id='{id}' class='method'>\
2151 <span id='{ns_id}' class='invisible'><code>",
2154 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl)?;
2155 write!(w, "</code>")?;
2156 render_stability_since(w, m, t)?;
2157 write!(w, "</span></h3>")?;
2158 document(w, cx, m)?;
2162 if !types.is_empty() {
2164 <h2 id='associated-types' class='small-section-header'>
2165 Associated Types<a href='#associated-types' class='anchor'></a>
2167 <div class='methods'>
2170 trait_item(w, cx, *t, it)?;
2172 write!(w, "</div>")?;
2175 if !consts.is_empty() {
2177 <h2 id='associated-const' class='small-section-header'>
2178 Associated Constants<a href='#associated-const' class='anchor'></a>
2180 <div class='methods'>
2183 trait_item(w, cx, *t, it)?;
2185 write!(w, "</div>")?;
2188 // Output the documentation for each function individually
2189 if !required.is_empty() {
2191 <h2 id='required-methods' class='small-section-header'>
2192 Required Methods<a href='#required-methods' class='anchor'></a>
2194 <div class='methods'>
2196 for m in &required {
2197 trait_item(w, cx, *m, it)?;
2199 write!(w, "</div>")?;
2201 if !provided.is_empty() {
2203 <h2 id='provided-methods' class='small-section-header'>
2204 Provided Methods<a href='#provided-methods' class='anchor'></a>
2206 <div class='methods'>
2208 for m in &provided {
2209 trait_item(w, cx, *m, it)?;
2211 write!(w, "</div>")?;
2214 // If there are methods directly on this trait object, render them here.
2215 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2217 let cache = cache();
2219 <h2 id='implementors' class='small-section-header'>
2220 Implementors<a href='#implementors' class='anchor'></a>
2222 <ul class='item-list' id='implementors-list'>
2224 if let Some(implementors) = cache.implementors.get(&it.def_id) {
2225 // The DefId is for the first Type found with that name. The bool is
2226 // if any Types with the same name but different DefId have been found.
2227 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap();
2228 for implementor in implementors {
2229 match implementor.impl_.for_ {
2230 clean::ResolvedPath { ref path, did, is_generic: false, .. } |
2231 clean::BorrowedRef {
2232 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2235 let &mut (prev_did, ref mut has_duplicates) =
2236 implementor_dups.entry(path.last_name()).or_insert((did, false));
2237 if prev_did != did {
2238 *has_duplicates = true;
2245 for implementor in implementors {
2246 write!(w, "<li><code>")?;
2247 // If there's already another implementor that has the same abbridged name, use the
2248 // full path, for example in `std::iter::ExactSizeIterator`
2249 let use_absolute = match implementor.impl_.for_ {
2250 clean::ResolvedPath { ref path, is_generic: false, .. } |
2251 clean::BorrowedRef {
2252 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2254 } => implementor_dups[path.last_name()].1,
2257 fmt_impl_for_trait_page(&implementor.impl_, w, use_absolute)?;
2258 for it in &implementor.impl_.items {
2259 if let clean::TypedefItem(ref tydef, _) = it.inner {
2260 write!(w, "<span class=\"where fmt-newline\"> ")?;
2261 assoc_type(w, it, &vec![], Some(&tydef.type_), AssocItemLink::Anchor(None))?;
2262 write!(w, ";</span>")?;
2265 writeln!(w, "</code></li>")?;
2268 write!(w, "</ul>")?;
2269 write!(w, r#"<script type="text/javascript" async
2270 src="{root_path}/implementors/{path}/{ty}.{name}.js">
2272 root_path = vec![".."; cx.current.len()].join("/"),
2273 path = if it.def_id.is_local() {
2274 cx.current.join("/")
2276 let (ref path, _) = cache.external_paths[&it.def_id];
2277 path[..path.len() - 1].join("/")
2279 ty = it.type_().css_class(),
2280 name = *it.name.as_ref().unwrap())?;
2284 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink) -> String {
2285 use html::item_type::ItemType::*;
2287 let name = it.name.as_ref().unwrap();
2288 let ty = match it.type_() {
2289 Typedef | AssociatedType => AssociatedType,
2293 let anchor = format!("#{}.{}", ty, name);
2295 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2296 AssocItemLink::Anchor(None) => anchor,
2297 AssocItemLink::GotoSource(did, _) => {
2298 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
2303 fn assoc_const(w: &mut fmt::Formatter,
2306 _default: Option<&String>,
2307 link: AssocItemLink) -> fmt::Result {
2308 write!(w, "const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
2309 naive_assoc_href(it, link),
2310 it.name.as_ref().unwrap(),
2315 fn assoc_type(w: &mut fmt::Formatter, it: &clean::Item,
2316 bounds: &Vec<clean::TyParamBound>,
2317 default: Option<&clean::Type>,
2318 link: AssocItemLink) -> fmt::Result {
2319 write!(w, "type <a href='{}' class=\"type\">{}</a>",
2320 naive_assoc_href(it, link),
2321 it.name.as_ref().unwrap())?;
2322 if !bounds.is_empty() {
2323 write!(w, ": {}", TyParamBounds(bounds))?
2325 if let Some(default) = default {
2326 write!(w, " = {}", default)?;
2331 fn render_stability_since_raw<'a>(w: &mut fmt::Formatter,
2332 ver: Option<&'a str>,
2333 containing_ver: Option<&'a str>) -> fmt::Result {
2334 if let Some(v) = ver {
2335 if containing_ver != ver && v.len() > 0 {
2336 write!(w, "<div class='since' title='Stable since Rust version {0}'>{0}</div>",
2343 fn render_stability_since(w: &mut fmt::Formatter,
2345 containing_item: &clean::Item) -> fmt::Result {
2346 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
2349 fn render_assoc_item(w: &mut fmt::Formatter,
2351 link: AssocItemLink,
2352 parent: ItemType) -> fmt::Result {
2353 fn method(w: &mut fmt::Formatter,
2355 unsafety: hir::Unsafety,
2356 constness: hir::Constness,
2358 g: &clean::Generics,
2360 link: AssocItemLink,
2363 let name = meth.name.as_ref().unwrap();
2364 let anchor = format!("#{}.{}", meth.type_(), name);
2365 let href = match link {
2366 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2367 AssocItemLink::Anchor(None) => anchor,
2368 AssocItemLink::GotoSource(did, provided_methods) => {
2369 // We're creating a link from an impl-item to the corresponding
2370 // trait-item and need to map the anchored type accordingly.
2371 let ty = if provided_methods.contains(name) {
2377 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
2380 // FIXME(#24111): remove when `const_fn` is stabilized
2381 let vis_constness = if is_nightly_build() {
2384 hir::Constness::NotConst
2386 let mut head_len = format!("{}{}{:#}fn {}{:#}",
2387 ConstnessSpace(vis_constness),
2388 UnsafetySpace(unsafety),
2392 let (indent, end_newline) = if parent == ItemType::Trait {
2398 write!(w, "{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
2399 {generics}{decl}{where_clause}",
2400 ConstnessSpace(vis_constness),
2401 UnsafetySpace(unsafety),
2411 where_clause = WhereClause {
2414 end_newline: end_newline,
2418 clean::StrippedItem(..) => Ok(()),
2419 clean::TyMethodItem(ref m) => {
2420 method(w, item, m.unsafety, hir::Constness::NotConst,
2421 m.abi, &m.generics, &m.decl, link, parent)
2423 clean::MethodItem(ref m) => {
2424 method(w, item, m.unsafety, m.constness,
2425 m.abi, &m.generics, &m.decl, link, parent)
2427 clean::AssociatedConstItem(ref ty, ref default) => {
2428 assoc_const(w, item, ty, default.as_ref(), link)
2430 clean::AssociatedTypeItem(ref bounds, ref default) => {
2431 assoc_type(w, item, bounds, default.as_ref(), link)
2433 _ => panic!("render_assoc_item called on non-associated-item")
2437 fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2438 s: &clean::Struct) -> fmt::Result {
2439 write!(w, "<pre class='rust struct'>")?;
2440 render_attributes(w, it)?;
2448 write!(w, "</pre>")?;
2450 document(w, cx, it)?;
2451 let mut fields = s.fields.iter().filter_map(|f| {
2453 clean::StructFieldItem(ref ty) => Some((f, ty)),
2457 if let doctree::Plain = s.struct_type {
2458 if fields.peek().is_some() {
2459 write!(w, "<h2 id='fields' class='fields small-section-header'>
2460 Fields<a href='#fields' class='anchor'></a></h2>")?;
2461 for (field, ty) in fields {
2462 let id = derive_id(format!("{}.{}",
2463 ItemType::StructField,
2464 field.name.as_ref().unwrap()));
2465 let ns_id = derive_id(format!("{}.{}",
2466 field.name.as_ref().unwrap(),
2467 ItemType::StructField.name_space()));
2468 write!(w, "<span id='{id}' class=\"{item_type}\">
2469 <span id='{ns_id}' class='invisible'>
2470 <code>{name}: {ty}</code>
2472 item_type = ItemType::StructField,
2475 name = field.name.as_ref().unwrap(),
2477 if let Some(stability_class) = field.stability_class() {
2478 write!(w, "<span class='stab {stab}'></span>",
2479 stab = stability_class)?;
2481 document(w, cx, field)?;
2485 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2488 fn item_union(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2489 s: &clean::Union) -> fmt::Result {
2490 write!(w, "<pre class='rust union'>")?;
2491 render_attributes(w, it)?;
2498 write!(w, "</pre>")?;
2500 document(w, cx, it)?;
2501 let mut fields = s.fields.iter().filter_map(|f| {
2503 clean::StructFieldItem(ref ty) => Some((f, ty)),
2507 if fields.peek().is_some() {
2508 write!(w, "<h2 id='fields' class='fields small-section-header'>
2509 Fields<a href='#fields' class='anchor'></a></h2>")?;
2510 for (field, ty) in fields {
2511 write!(w, "<span id='{shortty}.{name}' class=\"{shortty}\"><code>{name}: {ty}</code>
2513 shortty = ItemType::StructField,
2514 name = field.name.as_ref().unwrap(),
2516 if let Some(stability_class) = field.stability_class() {
2517 write!(w, "<span class='stab {stab}'></span>",
2518 stab = stability_class)?;
2520 document(w, cx, field)?;
2523 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2526 fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2527 e: &clean::Enum) -> fmt::Result {
2528 write!(w, "<pre class='rust enum'>")?;
2529 render_attributes(w, it)?;
2530 write!(w, "{}enum {}{}{}",
2531 VisSpace(&it.visibility),
2532 it.name.as_ref().unwrap(),
2534 WhereClause { gens: &e.generics, indent: 0, end_newline: true })?;
2535 if e.variants.is_empty() && !e.variants_stripped {
2536 write!(w, " {{}}")?;
2538 write!(w, " {{\n")?;
2539 for v in &e.variants {
2541 let name = v.name.as_ref().unwrap();
2543 clean::VariantItem(ref var) => {
2545 clean::VariantKind::CLike => write!(w, "{}", name)?,
2546 clean::VariantKind::Tuple(ref tys) => {
2547 write!(w, "{}(", name)?;
2548 for (i, ty) in tys.iter().enumerate() {
2550 write!(w, ", ")?
2552 write!(w, "{}", *ty)?;
2556 clean::VariantKind::Struct(ref s) => {
2572 if e.variants_stripped {
2573 write!(w, " // some variants omitted\n")?;
2577 write!(w, "</pre>")?;
2579 document(w, cx, it)?;
2580 if !e.variants.is_empty() {
2581 write!(w, "<h2 id='variants' class='variants small-section-header'>
2582 Variants<a href='#variants' class='anchor'></a></h2>\n")?;
2583 for variant in &e.variants {
2584 let id = derive_id(format!("{}.{}",
2586 variant.name.as_ref().unwrap()));
2587 let ns_id = derive_id(format!("{}.{}",
2588 variant.name.as_ref().unwrap(),
2589 ItemType::Variant.name_space()));
2590 write!(w, "<span id='{id}' class='variant'>\
2591 <span id='{ns_id}' class='invisible'><code>{name}",
2594 name = variant.name.as_ref().unwrap())?;
2595 if let clean::VariantItem(ref var) = variant.inner {
2596 if let clean::VariantKind::Tuple(ref tys) = var.kind {
2598 for (i, ty) in tys.iter().enumerate() {
2600 write!(w, ", ")?;
2602 write!(w, "{}", *ty)?;
2607 write!(w, "</code></span></span>")?;
2608 document(w, cx, variant)?;
2610 use clean::{Variant, VariantKind};
2611 if let clean::VariantItem(Variant {
2612 kind: VariantKind::Struct(ref s)
2613 }) = variant.inner {
2614 let variant_id = derive_id(format!("{}.{}.fields",
2616 variant.name.as_ref().unwrap()));
2617 write!(w, "<span class='docblock autohide sub-variant' id='{id}'>",
2619 write!(w, "<h3 class='fields'>Fields of <code>{name}</code></h3>\n
2620 <table>", name = variant.name.as_ref().unwrap())?;
2621 for field in &s.fields {
2622 use clean::StructFieldItem;
2623 if let StructFieldItem(ref ty) = field.inner {
2624 let id = derive_id(format!("variant.{}.field.{}",
2625 variant.name.as_ref().unwrap(),
2626 field.name.as_ref().unwrap()));
2627 let ns_id = derive_id(format!("{}.{}.{}.{}",
2628 variant.name.as_ref().unwrap(),
2629 ItemType::Variant.name_space(),
2630 field.name.as_ref().unwrap(),
2631 ItemType::StructField.name_space()));
2632 write!(w, "<tr><td \
2634 <span id='{ns_id}' class='invisible'>\
2635 <code>{f}: {t}</code></span></td><td>",
2638 f = field.name.as_ref().unwrap(),
2640 document(w, cx, field)?;
2641 write!(w, "</td></tr>")?;
2644 write!(w, "</table></span>")?;
2646 render_stability_since(w, variant, it)?;
2649 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2653 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
2654 let name = attr.name();
2657 Some(format!("{}", name))
2658 } else if let Some(v) = attr.value_str() {
2659 Some(format!("{} = {:?}", name, v.as_str()))
2660 } else if let Some(values) = attr.meta_item_list() {
2661 let display: Vec<_> = values.iter().filter_map(|attr| {
2662 attr.meta_item().and_then(|mi| render_attribute(mi))
2665 if display.len() > 0 {
2666 Some(format!("{}({})", name, display.join(", ")))
2675 const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
2682 "unsafe_destructor_blind_to_params"
2685 fn render_attributes(w: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
2686 let mut attrs = String::new();
2688 for attr in &it.attrs.other_attrs {
2689 let name = attr.name().unwrap();
2690 if !ATTRIBUTE_WHITELIST.contains(&&*name.as_str()) {
2693 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
2694 attrs.push_str(&format!("#[{}]\n", s));
2697 if attrs.len() > 0 {
2698 write!(w, "<div class=\"docblock attributes\">{}</div>", &attrs)?;
2703 fn render_struct(w: &mut fmt::Formatter, it: &clean::Item,
2704 g: Option<&clean::Generics>,
2705 ty: doctree::StructType,
2706 fields: &[clean::Item],
2708 structhead: bool) -> fmt::Result {
2710 VisSpace(&it.visibility),
2711 if structhead {"struct "} else {""},
2712 it.name.as_ref().unwrap())?;
2713 if let Some(g) = g {
2718 if let Some(g) = g {
2719 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?
2721 let mut has_visible_fields = false;
2723 for field in fields {
2724 if let clean::StructFieldItem(ref ty) = field.inner {
2725 write!(w, "\n{} {}{}: {},",
2727 VisSpace(&field.visibility),
2728 field.name.as_ref().unwrap(),
2730 has_visible_fields = true;
2734 if has_visible_fields {
2735 if it.has_stripped_fields().unwrap() {
2736 write!(w, "\n{} // some fields omitted", tab)?;
2738 write!(w, "\n{}", tab)?;
2739 } else if it.has_stripped_fields().unwrap() {
2740 // If there are no visible fields we can just display
2741 // `{ /* fields omitted */ }` to save space.
2742 write!(w, " /* fields omitted */ ")?;
2748 for (i, field) in fields.iter().enumerate() {
2753 clean::StrippedItem(box clean::StructFieldItem(..)) => {
2756 clean::StructFieldItem(ref ty) => {
2757 write!(w, "{}{}", VisSpace(&field.visibility), *ty)?
2763 if let Some(g) = g {
2764 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2769 // Needed for PhantomData.
2770 if let Some(g) = g {
2771 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2779 fn render_union(w: &mut fmt::Formatter, it: &clean::Item,
2780 g: Option<&clean::Generics>,
2781 fields: &[clean::Item],
2783 structhead: bool) -> fmt::Result {
2785 VisSpace(&it.visibility),
2786 if structhead {"union "} else {""},
2787 it.name.as_ref().unwrap())?;
2788 if let Some(g) = g {
2789 write!(w, "{}", g)?;
2790 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?;
2793 write!(w, " {{\n{}", tab)?;
2794 for field in fields {
2795 if let clean::StructFieldItem(ref ty) = field.inner {
2796 write!(w, " {}{}: {},\n{}",
2797 VisSpace(&field.visibility),
2798 field.name.as_ref().unwrap(),
2804 if it.has_stripped_fields().unwrap() {
2805 write!(w, " // some fields omitted\n{}", tab)?;
2811 #[derive(Copy, Clone)]
2812 enum AssocItemLink<'a> {
2813 Anchor(Option<&'a str>),
2814 GotoSource(DefId, &'a FxHashSet<String>),
2817 impl<'a> AssocItemLink<'a> {
2818 fn anchor(&self, id: &'a String) -> Self {
2820 AssocItemLink::Anchor(_) => { AssocItemLink::Anchor(Some(&id)) },
2821 ref other => *other,
2826 enum AssocItemRender<'a> {
2828 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool }
2831 #[derive(Copy, Clone, PartialEq)]
2834 ForDeref { mut_: bool },
2837 fn render_assoc_items(w: &mut fmt::Formatter,
2839 containing_item: &clean::Item,
2841 what: AssocItemRender) -> fmt::Result {
2843 let v = match c.impls.get(&it) {
2845 None => return Ok(()),
2847 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| {
2848 i.inner_impl().trait_.is_none()
2850 if !non_trait.is_empty() {
2851 let render_mode = match what {
2852 AssocItemRender::All => {
2854 <h2 id='methods' class='small-section-header'>
2855 Methods<a href='#methods' class='anchor'></a>
2860 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
2862 <h2 id='deref-methods' class='small-section-header'>
2863 Methods from {}<Target = {}><a href='#deref-methods' class='anchor'></a>
2866 RenderMode::ForDeref { mut_: deref_mut_ }
2869 for i in &non_trait {
2870 render_impl(w, cx, i, AssocItemLink::Anchor(None), render_mode,
2871 containing_item.stable_since())?;
2874 if let AssocItemRender::DerefFor { .. } = what {
2877 if !traits.is_empty() {
2878 let deref_impl = traits.iter().find(|t| {
2879 t.inner_impl().trait_.def_id() == c.deref_trait_did
2881 if let Some(impl_) = deref_impl {
2882 let has_deref_mut = traits.iter().find(|t| {
2883 t.inner_impl().trait_.def_id() == c.deref_mut_trait_did
2885 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut)?;
2888 <h2 id='implementations' class='small-section-header'>
2889 Trait Implementations<a href='#implementations' class='anchor'></a>
2893 let did = i.trait_did().unwrap();
2894 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2895 render_impl(w, cx, i, assoc_link,
2896 RenderMode::Normal, containing_item.stable_since())?;
2902 fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl,
2903 container_item: &clean::Item, deref_mut: bool) -> fmt::Result {
2904 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
2905 let target = impl_.inner_impl().items.iter().filter_map(|item| {
2907 clean::TypedefItem(ref t, true) => Some(&t.type_),
2910 }).next().expect("Expected associated type binding");
2911 let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target,
2912 deref_mut_: deref_mut };
2913 if let Some(did) = target.def_id() {
2914 render_assoc_items(w, cx, container_item, did, what)
2916 if let Some(prim) = target.primitive_type() {
2917 if let Some(&did) = cache().primitive_locations.get(&prim) {
2918 render_assoc_items(w, cx, container_item, did, what)?;
2925 fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink,
2926 render_mode: RenderMode, outer_version: Option<&str>) -> fmt::Result {
2927 if render_mode == RenderMode::Normal {
2928 write!(w, "<h3 class='impl'><span class='in-band'><code>{}</code>", i.inner_impl())?;
2929 write!(w, "</span><span class='out-of-band'>")?;
2930 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
2931 if let Some(l) = (Item { item: &i.impl_item, cx: cx }).src_href() {
2932 write!(w, "<div class='ghost'></div>")?;
2933 render_stability_since_raw(w, since, outer_version)?;
2934 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2935 l, "goto source code")?;
2937 render_stability_since_raw(w, since, outer_version)?;
2939 write!(w, "</span>")?;
2940 write!(w, "</h3>\n")?;
2941 if let Some(ref dox) = i.impl_item.doc_value() {
2942 write!(w, "<div class='docblock'>{}</div>", Markdown(dox, cx.render_type))?;
2946 fn doc_impl_item(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
2947 link: AssocItemLink, render_mode: RenderMode,
2948 is_default_item: bool, outer_version: Option<&str>,
2949 trait_: Option<&clean::Trait>) -> fmt::Result {
2950 let item_type = item.type_();
2951 let name = item.name.as_ref().unwrap();
2953 let render_method_item: bool = match render_mode {
2954 RenderMode::Normal => true,
2955 RenderMode::ForDeref { mut_: deref_mut_ } => {
2956 let self_type_opt = match item.inner {
2957 clean::MethodItem(ref method) => method.decl.self_type(),
2958 clean::TyMethodItem(ref method) => method.decl.self_type(),
2962 if let Some(self_ty) = self_type_opt {
2963 let (by_mut_ref, by_box) = match self_ty {
2964 SelfTy::SelfBorrowed(_, mutability) |
2965 SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
2966 (mutability == Mutability::Mutable, false)
2968 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
2969 (false, Some(did) == cache().owned_box_did)
2971 _ => (false, false),
2974 (deref_mut_ || !by_mut_ref) && !by_box
2982 clean::MethodItem(..) | clean::TyMethodItem(..) => {
2983 // Only render when the method is not static or we allow static methods
2984 if render_method_item {
2985 let id = derive_id(format!("{}.{}", item_type, name));
2986 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2987 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2988 write!(w, "<span id='{}' class='invisible'>", ns_id)?;
2989 write!(w, "<code>")?;
2990 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl)?;
2991 write!(w, "</code>")?;
2992 if let Some(l) = (Item { cx, item }).src_href() {
2993 write!(w, "</span><span class='out-of-band'>")?;
2994 write!(w, "<div class='ghost'></div>")?;
2995 render_stability_since_raw(w, item.stable_since(), outer_version)?;
2996 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2997 l, "goto source code")?;
2999 render_stability_since_raw(w, item.stable_since(), outer_version)?;
3001 write!(w, "</span></h4>\n")?;
3004 clean::TypedefItem(ref tydef, _) => {
3005 let id = derive_id(format!("{}.{}", ItemType::AssociatedType, name));
3006 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
3007 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3008 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3009 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id))?;
3010 write!(w, "</code></span></h4>\n")?;
3012 clean::AssociatedConstItem(ref ty, ref default) => {
3013 let id = derive_id(format!("{}.{}", item_type, name));
3014 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
3015 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3016 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3017 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id))?;
3018 write!(w, "</code></span></h4>\n")?;
3020 clean::AssociatedTypeItem(ref bounds, ref default) => {
3021 let id = derive_id(format!("{}.{}", item_type, name));
3022 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
3023 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3024 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3025 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id))?;
3026 write!(w, "</code></span></h4>\n")?;
3028 clean::StrippedItem(..) => return Ok(()),
3029 _ => panic!("can't make docs for trait item with name {:?}", item.name)
3032 if render_method_item || render_mode == RenderMode::Normal {
3033 let prefix = render_assoc_const_value(item);
3034 if !is_default_item {
3035 if let Some(t) = trait_ {
3036 // The trait item may have been stripped so we might not
3037 // find any documentation or stability for it.
3038 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
3039 // We need the stability of the item from the trait
3040 // because impls can't have a stability.
3041 document_stability(w, cx, it)?;
3042 if item.doc_value().is_some() {
3043 document_full(w, item, cx.render_type, &prefix)?;
3045 // In case the item isn't documented,
3046 // provide short documentation from the trait.
3047 document_short(w, it, link, cx.render_type, &prefix)?;
3051 document_stability(w, cx, item)?;
3052 document_full(w, item, cx.render_type, &prefix)?;
3055 document_stability(w, cx, item)?;
3056 document_short(w, item, link, cx.render_type, &prefix)?;
3062 let traits = &cache().traits;
3063 let trait_ = i.trait_did().and_then(|did| traits.get(&did));
3065 write!(w, "<div class='impl-items'>")?;
3066 for trait_item in &i.inner_impl().items {
3067 doc_impl_item(w, cx, trait_item, link, render_mode,
3068 false, outer_version, trait_)?;
3071 fn render_default_items(w: &mut fmt::Formatter,
3075 render_mode: RenderMode,
3076 outer_version: Option<&str>) -> fmt::Result {
3077 for trait_item in &t.items {
3078 let n = trait_item.name.clone();
3079 if i.items.iter().find(|m| m.name == n).is_some() {
3082 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3083 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3085 doc_impl_item(w, cx, trait_item, assoc_link, render_mode, true,
3086 outer_version, None)?;
3091 // If we've implemented a trait, then also emit documentation for all
3092 // default items which weren't overridden in the implementation block.
3093 if let Some(t) = trait_ {
3094 render_default_items(w, cx, t, &i.inner_impl(), render_mode, outer_version)?;
3096 write!(w, "</div>")?;
3100 fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3101 t: &clean::Typedef) -> fmt::Result {
3102 write!(w, "<pre class='rust typedef'>")?;
3103 render_attributes(w, it)?;
3104 write!(w, "type {}{}{where_clause} = {type_};</pre>",
3105 it.name.as_ref().unwrap(),
3107 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3110 document(w, cx, it)?;
3112 // Render any items associated directly to this alias, as otherwise they
3113 // won't be visible anywhere in the docs. It would be nice to also show
3114 // associated items from the aliased type (see discussion in #32077), but
3115 // we need #14072 to make sense of the generics.
3116 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3119 impl<'a> fmt::Display for Sidebar<'a> {
3120 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3123 let parentlen = cx.current.len() - if it.is_mod() {1} else {0};
3125 if it.is_struct() || it.is_trait() || it.is_primitive() || it.is_union()
3126 || it.is_enum() || it.is_mod() || it.is_typedef()
3128 write!(fmt, "<p class='location'>")?;
3130 clean::StructItem(..) => write!(fmt, "Struct ")?,
3131 clean::TraitItem(..) => write!(fmt, "Trait ")?,
3132 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
3133 clean::UnionItem(..) => write!(fmt, "Union ")?,
3134 clean::EnumItem(..) => write!(fmt, "Enum ")?,
3135 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
3136 clean::ModuleItem(..) => if it.is_crate() {
3137 write!(fmt, "Crate ")?;
3139 write!(fmt, "Module ")?;
3143 write!(fmt, "{}", it.name.as_ref().unwrap())?;
3144 write!(fmt, "</p>")?;
3147 clean::StructItem(ref s) => sidebar_struct(fmt, it, s)?,
3148 clean::TraitItem(ref t) => sidebar_trait(fmt, it, t)?,
3149 clean::PrimitiveItem(ref p) => sidebar_primitive(fmt, it, p)?,
3150 clean::UnionItem(ref u) => sidebar_union(fmt, it, u)?,
3151 clean::EnumItem(ref e) => sidebar_enum(fmt, it, e)?,
3152 clean::TypedefItem(ref t, _) => sidebar_typedef(fmt, it, t)?,
3153 clean::ModuleItem(ref m) => sidebar_module(fmt, it, &m.items)?,
3158 // The sidebar is designed to display sibling functions, modules and
3159 // other miscellaneous information. since there are lots of sibling
3160 // items (and that causes quadratic growth in large modules),
3161 // we refactor common parts into a shared JavaScript file per module.
3162 // still, we don't move everything into JS because we want to preserve
3163 // as much HTML as possible in order to allow non-JS-enabled browsers
3164 // to navigate the documentation (though slightly inefficiently).
3166 write!(fmt, "<p class='location'>")?;
3167 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
3169 write!(fmt, "::<wbr>")?;
3171 write!(fmt, "<a href='{}index.html'>{}</a>",
3172 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
3175 write!(fmt, "</p>")?;
3177 // Sidebar refers to the enclosing module, not this module.
3178 let relpath = if it.is_mod() { "../" } else { "" };
3180 "<script>window.sidebarCurrent = {{\
3185 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
3186 ty = it.type_().css_class(),
3189 // There is no sidebar-items.js beyond the crate root path
3190 // FIXME maybe dynamic crate loading can be merged here
3192 write!(fmt, "<script defer src=\"{path}sidebar-items.js\"></script>",
3200 fn sidebar_assoc_items(it: &clean::Item) -> String {
3201 let mut out = String::new();
3203 if let Some(v) = c.impls.get(&it.def_id) {
3204 if v.iter().any(|i| i.inner_impl().trait_.is_none()) {
3205 out.push_str("<li><a href=\"#methods\">Methods</a></li>");
3208 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
3209 if let Some(impl_) = v.iter()
3210 .filter(|i| i.inner_impl().trait_.is_some())
3211 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did) {
3212 if let Some(target) = impl_.inner_impl().items.iter().filter_map(|item| {
3214 clean::TypedefItem(ref t, true) => Some(&t.type_),
3218 let inner_impl = target.def_id().or(target.primitive_type().and_then(|prim| {
3219 c.primitive_locations.get(&prim).cloned()
3220 })).and_then(|did| c.impls.get(&did));
3221 if inner_impl.is_some() {
3222 out.push_str("<li><a href=\"#deref-methods\">");
3223 out.push_str(&format!("Methods from {:#}<Target={:#}>",
3224 impl_.inner_impl().trait_.as_ref().unwrap(),
3226 out.push_str("</a></li>");
3230 out.push_str("<li><a href=\"#implementations\">Trait Implementations</a></li>");
3237 fn sidebar_struct(fmt: &mut fmt::Formatter, it: &clean::Item,
3238 s: &clean::Struct) -> fmt::Result {
3239 let mut sidebar = String::new();
3242 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3243 if let doctree::Plain = s.struct_type {
3244 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3248 sidebar.push_str(&sidebar_assoc_items(it));
3250 if !sidebar.is_empty() {
3251 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3256 fn sidebar_trait(fmt: &mut fmt::Formatter, it: &clean::Item,
3257 t: &clean::Trait) -> fmt::Result {
3258 let mut sidebar = String::new();
3260 let has_types = t.items.iter().any(|m| m.is_associated_type());
3261 let has_consts = t.items.iter().any(|m| m.is_associated_const());
3262 let has_required = t.items.iter().any(|m| m.is_ty_method());
3263 let has_provided = t.items.iter().any(|m| m.is_method());
3266 sidebar.push_str("<li><a href=\"#associated-types\">Associated Types</a></li>");
3269 sidebar.push_str("<li><a href=\"#associated-const\">Associated Constants</a></li>");
3272 sidebar.push_str("<li><a href=\"#required-methods\">Required Methods</a></li>");
3275 sidebar.push_str("<li><a href=\"#provided-methods\">Provided Methods</a></li>");
3278 sidebar.push_str(&sidebar_assoc_items(it));
3280 sidebar.push_str("<li><a href=\"#implementors\">Implementors</a></li>");
3282 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)
3285 fn sidebar_primitive(fmt: &mut fmt::Formatter, it: &clean::Item,
3286 _p: &clean::PrimitiveType) -> fmt::Result {
3287 let sidebar = sidebar_assoc_items(it);
3289 if !sidebar.is_empty() {
3290 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3295 fn sidebar_typedef(fmt: &mut fmt::Formatter, it: &clean::Item,
3296 _t: &clean::Typedef) -> fmt::Result {
3297 let sidebar = sidebar_assoc_items(it);
3299 if !sidebar.is_empty() {
3300 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3305 fn sidebar_union(fmt: &mut fmt::Formatter, it: &clean::Item,
3306 u: &clean::Union) -> fmt::Result {
3307 let mut sidebar = String::new();
3310 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3311 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3314 sidebar.push_str(&sidebar_assoc_items(it));
3316 if !sidebar.is_empty() {
3317 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3322 fn sidebar_enum(fmt: &mut fmt::Formatter, it: &clean::Item,
3323 e: &clean::Enum) -> fmt::Result {
3324 let mut sidebar = String::new();
3326 if !e.variants.is_empty() {
3327 sidebar.push_str("<li><a href=\"#variants\">Variants</a></li>");
3330 sidebar.push_str(&sidebar_assoc_items(it));
3332 if !sidebar.is_empty() {
3333 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3338 fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
3339 items: &[clean::Item]) -> fmt::Result {
3340 let mut sidebar = String::new();
3342 if items.iter().any(|it| it.type_() == ItemType::ExternCrate ||
3343 it.type_() == ItemType::Import) {
3344 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3346 name = "Reexports"));
3349 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
3350 // to print its headings
3351 for &myty in &[ItemType::Primitive, ItemType::Module, ItemType::Macro, ItemType::Struct,
3352 ItemType::Enum, ItemType::Constant, ItemType::Static, ItemType::Trait,
3353 ItemType::Function, ItemType::Typedef, ItemType::Union, ItemType::Impl,
3354 ItemType::TyMethod, ItemType::Method, ItemType::StructField, ItemType::Variant,
3355 ItemType::AssociatedType, ItemType::AssociatedConst] {
3356 if items.iter().any(|it| {
3357 if let clean::DefaultImplItem(..) = it.inner {
3360 !it.is_stripped() && it.type_() == myty
3363 let (short, name) = match myty {
3364 ItemType::ExternCrate |
3365 ItemType::Import => ("reexports", "Reexports"),
3366 ItemType::Module => ("modules", "Modules"),
3367 ItemType::Struct => ("structs", "Structs"),
3368 ItemType::Union => ("unions", "Unions"),
3369 ItemType::Enum => ("enums", "Enums"),
3370 ItemType::Function => ("functions", "Functions"),
3371 ItemType::Typedef => ("types", "Type Definitions"),
3372 ItemType::Static => ("statics", "Statics"),
3373 ItemType::Constant => ("constants", "Constants"),
3374 ItemType::Trait => ("traits", "Traits"),
3375 ItemType::Impl => ("impls", "Implementations"),
3376 ItemType::TyMethod => ("tymethods", "Type Methods"),
3377 ItemType::Method => ("methods", "Methods"),
3378 ItemType::StructField => ("fields", "Struct Fields"),
3379 ItemType::Variant => ("variants", "Variants"),
3380 ItemType::Macro => ("macros", "Macros"),
3381 ItemType::Primitive => ("primitives", "Primitive Types"),
3382 ItemType::AssociatedType => ("associated-types", "Associated Types"),
3383 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
3385 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3391 if !sidebar.is_empty() {
3392 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3397 impl<'a> fmt::Display for Source<'a> {
3398 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3399 let Source(s) = *self;
3400 let lines = s.lines().count();
3402 let mut tmp = lines;
3407 write!(fmt, "<pre class=\"line-numbers\">")?;
3408 for i in 1..lines + 1 {
3409 write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
3411 write!(fmt, "</pre>")?;
3412 write!(fmt, "{}", highlight::render_with_highlighting(s, None, None, None))?;
3417 fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3418 t: &clean::Macro) -> fmt::Result {
3419 w.write_str(&highlight::render_with_highlighting(&t.source,
3426 fn item_primitive(w: &mut fmt::Formatter, cx: &Context,
3428 _p: &clean::PrimitiveType) -> fmt::Result {
3429 document(w, cx, it)?;
3430 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3433 const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
3435 fn make_item_keywords(it: &clean::Item) -> String {
3436 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
3439 fn get_index_search_type(item: &clean::Item) -> Option<IndexItemFunctionType> {
3440 let decl = match item.inner {
3441 clean::FunctionItem(ref f) => &f.decl,
3442 clean::MethodItem(ref m) => &m.decl,
3443 clean::TyMethodItem(ref m) => &m.decl,
3447 let inputs = decl.inputs.values.iter().map(|arg| get_index_type(&arg.type_)).collect();
3448 let output = match decl.output {
3449 clean::FunctionRetTy::Return(ref return_type) => Some(get_index_type(return_type)),
3453 Some(IndexItemFunctionType { inputs: inputs, output: output })
3456 fn get_index_type(clean_type: &clean::Type) -> Type {
3457 Type { name: get_index_type_name(clean_type).map(|s| s.to_ascii_lowercase()) }
3460 fn get_index_type_name(clean_type: &clean::Type) -> Option<String> {
3462 clean::ResolvedPath { ref path, .. } => {
3463 let segments = &path.segments;
3464 Some(segments[segments.len() - 1].name.clone())
3466 clean::Generic(ref s) => Some(s.clone()),
3467 clean::Primitive(ref p) => Some(format!("{:?}", p)),
3468 clean::BorrowedRef { ref type_, .. } => get_index_type_name(type_),
3469 // FIXME: add all from clean::Type.
3474 pub fn cache() -> Arc<Cache> {
3475 CACHE_KEY.with(|c| c.borrow().clone())
3480 fn test_unique_id() {
3481 let input = ["foo", "examples", "examples", "method.into_iter","examples",
3482 "method.into_iter", "foo", "main", "search", "methods",
3483 "examples", "method.into_iter", "assoc_type.Item", "assoc_type.Item"];
3484 let expected = ["foo", "examples", "examples-1", "method.into_iter", "examples-2",
3485 "method.into_iter-1", "foo-1", "main-1", "search-1", "methods-1",
3486 "examples-3", "method.into_iter-2", "assoc_type.Item", "assoc_type.Item-1"];
3489 let actual: Vec<String> = input.iter().map(|s| derive_id(s.to_string())).collect();
3490 assert_eq!(&actual[..], expected);
3499 fn test_name_key() {
3500 assert_eq!(name_key("0"), ("", 0, 1));
3501 assert_eq!(name_key("123"), ("", 123, 0));
3502 assert_eq!(name_key("Fruit"), ("Fruit", 0, 0));
3503 assert_eq!(name_key("Fruit0"), ("Fruit", 0, 1));
3504 assert_eq!(name_key("Fruit0000"), ("Fruit", 0, 4));
3505 assert_eq!(name_key("Fruit01"), ("Fruit", 1, 1));
3506 assert_eq!(name_key("Fruit10"), ("Fruit", 10, 0));
3507 assert_eq!(name_key("Fruit123"), ("Fruit", 123, 0));
3512 fn test_name_sorting() {
3513 let names = ["Apple",
3515 "Fruit", "Fruit0", "Fruit00",
3516 "Fruit1", "Fruit01",
3517 "Fruit2", "Fruit02",
3521 let mut sorted = names.to_owned();
3522 sorted.sort_by_key(|&s| name_key(s));
3523 assert_eq!(names, sorted);