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>,
266 // In rare case where a structure is defined in one module but implemented
267 // in another, if the implementing module is parsed before defining module,
268 // then the fully qualified name of the structure isn't presented in `paths`
269 // yet when its implementation methods are being indexed. Caches such methods
270 // and their parent id here and indexes them at the end of crate parsing.
271 orphan_impl_items: Vec<(DefId, clean::Item)>,
274 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
275 /// Later on moved into `CACHE_KEY`.
277 pub struct RenderInfo {
278 pub inlined: FxHashSet<DefId>,
279 pub external_paths: ::core::ExternalPaths,
280 pub external_typarams: FxHashMap<DefId, String>,
281 pub deref_trait_did: Option<DefId>,
282 pub deref_mut_trait_did: Option<DefId>,
285 /// Helper struct to render all source code to HTML pages
286 struct SourceCollector<'a> {
287 scx: &'a mut SharedContext,
289 /// Root destination to place all HTML output into
293 /// Wrapper struct to render the source code of a file. This will do things like
294 /// adding line numbers to the left-hand side.
295 struct Source<'a>(&'a str);
297 // Helper structs for rendering items/sidebars and carrying along contextual
300 #[derive(Copy, Clone)]
303 item: &'a clean::Item,
306 struct Sidebar<'a> { cx: &'a Context, item: &'a clean::Item, }
308 /// Struct representing one entry in the JS search index. These are all emitted
309 /// by hand to a large JS file at the end of cache-creation.
315 parent: Option<DefId>,
316 parent_idx: Option<usize>,
317 search_type: Option<IndexItemFunctionType>,
320 impl ToJson for IndexItem {
321 fn to_json(&self) -> Json {
322 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
324 let mut data = Vec::with_capacity(6);
325 data.push((self.ty as usize).to_json());
326 data.push(self.name.to_json());
327 data.push(self.path.to_json());
328 data.push(self.desc.to_json());
329 data.push(self.parent_idx.to_json());
330 data.push(self.search_type.to_json());
336 /// A type used for the search index.
338 name: Option<String>,
341 impl ToJson for Type {
342 fn to_json(&self) -> Json {
345 let mut data = BTreeMap::new();
346 data.insert("name".to_owned(), name.to_json());
354 /// Full type of functions/methods in the search index.
355 struct IndexItemFunctionType {
360 impl ToJson for IndexItemFunctionType {
361 fn to_json(&self) -> Json {
362 // If we couldn't figure out a type, just write `null`.
363 if self.inputs.iter().chain(self.output.iter()).any(|ref i| i.name.is_none()) {
366 let mut data = BTreeMap::new();
367 data.insert("inputs".to_owned(), self.inputs.to_json());
368 data.insert("output".to_owned(), self.output.to_json());
374 // TLS keys used to carry information around during rendering.
376 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
377 thread_local!(pub static CURRENT_LOCATION_KEY: RefCell<Vec<String>> =
378 RefCell::new(Vec::new()));
379 thread_local!(static USED_ID_MAP: RefCell<FxHashMap<String, usize>> =
380 RefCell::new(init_ids()));
382 fn init_ids() -> FxHashMap<String, usize> {
398 ].into_iter().map(|id| (String::from(*id), 1)).collect()
401 /// This method resets the local table of used ID attributes. This is typically
402 /// used at the beginning of rendering an entire HTML page to reset from the
403 /// previous state (if any).
404 pub fn reset_ids(embedded: bool) {
405 USED_ID_MAP.with(|s| {
406 *s.borrow_mut() = if embedded {
414 pub fn derive_id(candidate: String) -> String {
415 USED_ID_MAP.with(|map| {
416 let id = match map.borrow_mut().get_mut(&candidate) {
419 let id = format!("{}-{}", candidate, *a);
425 map.borrow_mut().insert(id.clone(), 1);
430 /// Generates the documentation for `crate` into the directory `dst`
431 pub fn run(mut krate: clean::Crate,
432 external_html: &ExternalHtml,
433 playground_url: Option<String>,
435 passes: FxHashSet<String>,
436 css_file_extension: Option<PathBuf>,
437 renderinfo: RenderInfo,
438 render_type: RenderType) -> Result<(), Error> {
439 let src_root = match krate.src.parent() {
440 Some(p) => p.to_path_buf(),
441 None => PathBuf::new(),
443 let mut scx = SharedContext {
446 include_sources: true,
447 local_sources: FxHashMap(),
448 issue_tracker_base_url: None,
449 layout: layout::Layout {
450 logo: "".to_string(),
451 favicon: "".to_string(),
452 external_html: external_html.clone(),
453 krate: krate.name.clone(),
455 css_file_extension: css_file_extension.clone(),
458 // If user passed in `--playground-url` arg, we fill in crate name here
459 if let Some(url) = playground_url {
460 markdown::PLAYGROUND.with(|slot| {
461 *slot.borrow_mut() = Some((Some(krate.name.clone()), url));
465 // Crawl the crate attributes looking for attributes which control how we're
466 // going to emit HTML
467 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
468 for attr in attrs.lists("doc") {
469 let name = attr.name().map(|s| s.as_str());
470 match (name.as_ref().map(|s| &s[..]), attr.value_str()) {
471 (Some("html_favicon_url"), Some(s)) => {
472 scx.layout.favicon = s.to_string();
474 (Some("html_logo_url"), Some(s)) => {
475 scx.layout.logo = s.to_string();
477 (Some("html_playground_url"), Some(s)) => {
478 markdown::PLAYGROUND.with(|slot| {
479 let name = krate.name.clone();
480 *slot.borrow_mut() = Some((Some(name), s.to_string()));
483 (Some("issue_tracker_base_url"), Some(s)) => {
484 scx.issue_tracker_base_url = Some(s.to_string());
486 (Some("html_no_source"), None) if attr.is_word() => {
487 scx.include_sources = false;
493 try_err!(mkdir(&dst), &dst);
494 krate = render_sources(&dst, &mut scx, krate)?;
498 render_redirect_pages: false,
499 shared: Arc::new(scx),
500 render_type: render_type,
503 // Crawl the crate to build various caches used for the output
512 let external_paths = external_paths.into_iter()
513 .map(|(k, (v, t))| (k, (v, ItemType::from(t))))
516 let mut cache = Cache {
518 external_paths: external_paths,
520 implementors: FxHashMap(),
522 parent_stack: Vec::new(),
523 search_index: Vec::new(),
524 parent_is_trait_impl: false,
525 extern_locations: FxHashMap(),
526 primitive_locations: FxHashMap(),
528 access_levels: krate.access_levels.clone(),
529 orphan_impl_items: Vec::new(),
530 traits: mem::replace(&mut krate.external_traits, FxHashMap()),
531 deref_trait_did: deref_trait_did,
532 deref_mut_trait_did: deref_mut_trait_did,
533 typarams: external_typarams,
536 // Cache where all our extern crates are located
537 for &(n, ref e) in &krate.externs {
538 let src_root = match Path::new(&e.src).parent() {
539 Some(p) => p.to_path_buf(),
540 None => PathBuf::new(),
542 cache.extern_locations.insert(n, (e.name.clone(), src_root,
543 extern_location(e, &cx.dst)));
545 let did = DefId { krate: n, index: CRATE_DEF_INDEX };
546 cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
549 // Cache where all known primitives have their documentation located.
551 // Favor linking to as local extern as possible, so iterate all crates in
552 // reverse topological order.
553 for &(_, ref e) in krate.externs.iter().rev() {
554 for &(def_id, prim, _) in &e.primitives {
555 cache.primitive_locations.insert(prim, def_id);
558 for &(def_id, prim, _) in &krate.primitives {
559 cache.primitive_locations.insert(prim, def_id);
562 cache.stack.push(krate.name.clone());
563 krate = cache.fold_crate(krate);
565 // Build our search index
566 let index = build_index(&krate, &mut cache);
568 // Freeze the cache now that the index has been built. Put an Arc into TLS
569 // for future parallelization opportunities
570 let cache = Arc::new(cache);
571 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
572 CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear());
574 write_shared(&cx, &krate, &*cache, index)?;
576 // And finally render the whole crate's documentation
580 /// Build the search index from the collected metadata
581 fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
582 let mut nodeid_to_pathid = FxHashMap();
583 let mut crate_items = Vec::with_capacity(cache.search_index.len());
584 let mut crate_paths = Vec::<Json>::new();
586 let Cache { ref mut search_index,
587 ref orphan_impl_items,
588 ref mut paths, .. } = *cache;
590 // Attach all orphan items to the type's definition if the type
591 // has since been learned.
592 for &(did, ref item) in orphan_impl_items {
593 if let Some(&(ref fqp, _)) = paths.get(&did) {
594 search_index.push(IndexItem {
596 name: item.name.clone().unwrap(),
597 path: fqp[..fqp.len() - 1].join("::"),
598 desc: plain_summary_line(item.doc_value()),
601 search_type: get_index_search_type(&item),
606 // Reduce `NodeId` in paths into smaller sequential numbers,
607 // and prune the paths that do not appear in the index.
608 let mut lastpath = String::new();
609 let mut lastpathid = 0usize;
611 for item in search_index {
612 item.parent_idx = item.parent.map(|nodeid| {
613 if nodeid_to_pathid.contains_key(&nodeid) {
614 *nodeid_to_pathid.get(&nodeid).unwrap()
616 let pathid = lastpathid;
617 nodeid_to_pathid.insert(nodeid, pathid);
620 let &(ref fqp, short) = paths.get(&nodeid).unwrap();
621 crate_paths.push(((short as usize), fqp.last().unwrap().clone()).to_json());
626 // Omit the parent path if it is same to that of the prior item.
627 if lastpath == item.path {
630 lastpath = item.path.clone();
632 crate_items.push(item.to_json());
635 let crate_doc = krate.module.as_ref().map(|module| {
636 plain_summary_line(module.doc_value())
637 }).unwrap_or(String::new());
639 let mut crate_data = BTreeMap::new();
640 crate_data.insert("doc".to_owned(), Json::String(crate_doc));
641 crate_data.insert("items".to_owned(), Json::Array(crate_items));
642 crate_data.insert("paths".to_owned(), Json::Array(crate_paths));
644 // Collect the index into a string
645 format!("searchIndex[{}] = {};",
646 as_json(&krate.name),
647 Json::Object(crate_data))
650 fn write_shared(cx: &Context,
651 krate: &clean::Crate,
653 search_index: String) -> Result<(), Error> {
654 // Write out the shared files. Note that these are shared among all rustdoc
655 // docs placed in the output directory, so this needs to be a synchronized
656 // operation with respect to all other rustdocs running around.
657 try_err!(mkdir(&cx.dst), &cx.dst);
658 let _lock = flock::Lock::panicking_new(&cx.dst.join(".lock"), true, true, true);
660 // Add all the static files. These may already exist, but we just
661 // overwrite them anyway to make sure that they're fresh and up-to-date.
663 write(cx.dst.join("jquery.js"),
664 include_bytes!("static/jquery-2.1.4.min.js"))?;
665 write(cx.dst.join("main.js"),
666 include_bytes!("static/main.js"))?;
667 write(cx.dst.join("rustdoc.css"),
668 include_bytes!("static/rustdoc.css"))?;
669 write(cx.dst.join("main.css"),
670 include_bytes!("static/styles/main.css"))?;
671 if let Some(ref css) = cx.shared.css_file_extension {
672 let mut content = String::new();
673 let css = css.as_path();
674 let mut f = try_err!(File::open(css), css);
676 try_err!(f.read_to_string(&mut content), css);
677 let css = cx.dst.join("theme.css");
678 let css = css.as_path();
679 let mut f = try_err!(File::create(css), css);
680 try_err!(write!(f, "{}", &content), css);
682 write(cx.dst.join("normalize.css"),
683 include_bytes!("static/normalize.css"))?;
684 write(cx.dst.join("FiraSans-Regular.woff"),
685 include_bytes!("static/FiraSans-Regular.woff"))?;
686 write(cx.dst.join("FiraSans-Medium.woff"),
687 include_bytes!("static/FiraSans-Medium.woff"))?;
688 write(cx.dst.join("FiraSans-LICENSE.txt"),
689 include_bytes!("static/FiraSans-LICENSE.txt"))?;
690 write(cx.dst.join("Heuristica-Italic.woff"),
691 include_bytes!("static/Heuristica-Italic.woff"))?;
692 write(cx.dst.join("Heuristica-LICENSE.txt"),
693 include_bytes!("static/Heuristica-LICENSE.txt"))?;
694 write(cx.dst.join("SourceSerifPro-Regular.woff"),
695 include_bytes!("static/SourceSerifPro-Regular.woff"))?;
696 write(cx.dst.join("SourceSerifPro-Bold.woff"),
697 include_bytes!("static/SourceSerifPro-Bold.woff"))?;
698 write(cx.dst.join("SourceSerifPro-LICENSE.txt"),
699 include_bytes!("static/SourceSerifPro-LICENSE.txt"))?;
700 write(cx.dst.join("SourceCodePro-Regular.woff"),
701 include_bytes!("static/SourceCodePro-Regular.woff"))?;
702 write(cx.dst.join("SourceCodePro-Semibold.woff"),
703 include_bytes!("static/SourceCodePro-Semibold.woff"))?;
704 write(cx.dst.join("SourceCodePro-LICENSE.txt"),
705 include_bytes!("static/SourceCodePro-LICENSE.txt"))?;
706 write(cx.dst.join("LICENSE-MIT.txt"),
707 include_bytes!("static/LICENSE-MIT.txt"))?;
708 write(cx.dst.join("LICENSE-APACHE.txt"),
709 include_bytes!("static/LICENSE-APACHE.txt"))?;
710 write(cx.dst.join("COPYRIGHT.txt"),
711 include_bytes!("static/COPYRIGHT.txt"))?;
713 fn collect(path: &Path, krate: &str,
714 key: &str) -> io::Result<Vec<String>> {
715 let mut ret = Vec::new();
717 for line in BufReader::new(File::open(path)?).lines() {
719 if !line.starts_with(key) {
722 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
725 ret.push(line.to_string());
731 // Update the search index
732 let dst = cx.dst.join("search-index.js");
733 let mut all_indexes = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
734 all_indexes.push(search_index);
735 // Sort the indexes by crate so the file will be generated identically even
736 // with rustdoc running in parallel.
738 let mut w = try_err!(File::create(&dst), &dst);
739 try_err!(writeln!(&mut w, "var searchIndex = {{}};"), &dst);
740 for index in &all_indexes {
741 try_err!(writeln!(&mut w, "{}", *index), &dst);
743 try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst);
745 // Update the list of all implementors for traits
746 let dst = cx.dst.join("implementors");
747 for (&did, imps) in &cache.implementors {
748 // Private modules can leak through to this phase of rustdoc, which
749 // could contain implementations for otherwise private types. In some
750 // rare cases we could find an implementation for an item which wasn't
751 // indexed, so we just skip this step in that case.
753 // FIXME: this is a vague explanation for why this can't be a `get`, in
754 // theory it should be...
755 let &(ref remote_path, remote_item_type) = match cache.paths.get(&did) {
757 None => match cache.external_paths.get(&did) {
763 let mut implementors = format!(r#"implementors["{}"] = ["#, krate.name);
765 // If the trait and implementation are in the same crate, then
766 // there's no need to emit information about it (there's inlining
767 // going on). If they're in different crates then the crate defining
768 // the trait will be interested in our implementation.
769 if imp.def_id.krate == did.krate { continue }
770 write!(implementors, "{},", as_json(&imp.impl_.to_string())).unwrap();
772 implementors.push_str("];");
774 let mut mydst = dst.clone();
775 for part in &remote_path[..remote_path.len() - 1] {
778 try_err!(fs::create_dir_all(&mydst), &mydst);
779 mydst.push(&format!("{}.{}.js",
780 remote_item_type.css_class(),
781 remote_path[remote_path.len() - 1]));
783 let mut all_implementors = try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
784 all_implementors.push(implementors);
785 // Sort the implementors by crate so the file will be generated
786 // identically even with rustdoc running in parallel.
787 all_implementors.sort();
789 let mut f = try_err!(File::create(&mydst), &mydst);
790 try_err!(writeln!(&mut f, "(function() {{var implementors = {{}};"), &mydst);
791 for implementor in &all_implementors {
792 try_err!(writeln!(&mut f, "{}", *implementor), &mydst);
794 try_err!(writeln!(&mut f, "{}", r"
795 if (window.register_implementors) {
796 window.register_implementors(implementors);
798 window.pending_implementors = implementors;
801 try_err!(writeln!(&mut f, r"}})()"), &mydst);
806 fn render_sources(dst: &Path, scx: &mut SharedContext,
807 krate: clean::Crate) -> Result<clean::Crate, Error> {
808 info!("emitting source files");
809 let dst = dst.join("src");
810 try_err!(mkdir(&dst), &dst);
811 let dst = dst.join(&krate.name);
812 try_err!(mkdir(&dst), &dst);
813 let mut folder = SourceCollector {
817 Ok(folder.fold_crate(krate))
820 /// Writes the entire contents of a string to a destination, not attempting to
821 /// catch any errors.
822 fn write(dst: PathBuf, contents: &[u8]) -> Result<(), Error> {
823 Ok(try_err!(try_err!(File::create(&dst), &dst).write_all(contents), &dst))
826 /// Makes a directory on the filesystem, failing the thread if an error occurs
827 /// and skipping if the directory already exists.
829 /// Note that this also handles races as rustdoc is likely to be run
830 /// concurrently against another invocation.
831 fn mkdir(path: &Path) -> io::Result<()> {
832 match fs::create_dir(path) {
834 Err(ref e) if e.kind() == io::ErrorKind::AlreadyExists => Ok(()),
839 /// Takes a path to a source file and cleans the path to it. This canonicalizes
840 /// things like ".." to components which preserve the "top down" hierarchy of a
841 /// static HTML tree. Each component in the cleaned path will be passed as an
842 /// argument to `f`. The very last component of the path (ie the file name) will
843 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
844 // FIXME (#9639): The closure should deal with &[u8] instead of &str
845 // FIXME (#9639): This is too conservative, rejecting non-UTF-8 paths
846 fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) where
849 // make it relative, if possible
850 let p = p.strip_prefix(src_root).unwrap_or(p);
852 let mut iter = p.components().peekable();
854 while let Some(c) = iter.next() {
855 if !keep_filename && iter.peek().is_none() {
860 Component::ParentDir => f("up"),
861 Component::Normal(c) => f(c.to_str().unwrap()),
867 /// Attempts to find where an external crate is located, given that we're
868 /// rendering in to the specified source destination.
869 fn extern_location(e: &clean::ExternalCrate, dst: &Path) -> ExternalLocation {
870 // See if there's documentation generated into the local directory
871 let local_location = dst.join(&e.name);
872 if local_location.is_dir() {
876 // Failing that, see if there's an attribute specifying where to find this
879 .filter(|a| a.check_name("html_root_url"))
880 .filter_map(|a| a.value_str())
882 let mut url = url.to_string();
883 if !url.ends_with("/") {
887 }).next().unwrap_or(Unknown) // Well, at least we tried.
890 impl<'a> DocFolder for SourceCollector<'a> {
891 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
892 // If we're including source files, and we haven't seen this file yet,
893 // then we need to render it out to the filesystem.
894 if self.scx.include_sources
895 // skip all invalid spans
896 && item.source.filename != ""
897 // skip non-local items
898 && item.def_id.is_local()
899 // Macros from other libraries get special filenames which we can
901 && !(item.source.filename.starts_with("<")
902 && item.source.filename.ends_with("macros>")) {
904 // If it turns out that we couldn't read this file, then we probably
905 // can't read any of the files (generating html output from json or
906 // something like that), so just don't include sources for the
907 // entire crate. The other option is maintaining this mapping on a
908 // per-file basis, but that's probably not worth it...
910 .include_sources = match self.emit_source(&item.source.filename) {
913 println!("warning: source code was requested to be rendered, \
914 but processing `{}` had an error: {}",
915 item.source.filename, e);
916 println!(" skipping rendering of source code");
921 self.fold_item_recur(item)
925 impl<'a> SourceCollector<'a> {
926 /// Renders the given filename into its corresponding HTML source file.
927 fn emit_source(&mut self, filename: &str) -> io::Result<()> {
928 let p = PathBuf::from(filename);
929 if self.scx.local_sources.contains_key(&p) {
930 // We've already emitted this source
934 let mut contents = Vec::new();
935 File::open(&p).and_then(|mut f| f.read_to_end(&mut contents))?;
937 let contents = str::from_utf8(&contents).unwrap();
939 // Remove the utf-8 BOM if any
940 let contents = if contents.starts_with("\u{feff}") {
946 // Create the intermediate directories
947 let mut cur = self.dst.clone();
948 let mut root_path = String::from("../../");
949 let mut href = String::new();
950 clean_srcpath(&self.scx.src_root, &p, false, |component| {
952 mkdir(&cur).unwrap();
953 root_path.push_str("../");
954 href.push_str(component);
957 let mut fname = p.file_name().expect("source has no filename")
961 href.push_str(&fname.to_string_lossy());
963 let mut w = BufWriter::new(File::create(&cur)?);
964 let title = format!("{} -- source", cur.file_name().unwrap()
966 let desc = format!("Source to the Rust file `{}`.", filename);
967 let page = layout::Page {
970 root_path: &root_path,
972 keywords: BASIC_KEYWORDS,
974 layout::render(&mut w, &self.scx.layout,
975 &page, &(""), &Source(contents),
976 self.scx.css_file_extension.is_some())?;
978 self.scx.local_sources.insert(p, href);
983 impl DocFolder for Cache {
984 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
985 // If this is a stripped module,
986 // we don't want it or its children in the search index.
987 let orig_stripped_mod = match item.inner {
988 clean::StrippedItem(box clean::ModuleItem(..)) => {
989 mem::replace(&mut self.stripped_mod, true)
991 _ => self.stripped_mod,
994 // Register any generics to their corresponding string. This is used
995 // when pretty-printing types.
996 if let Some(generics) = item.inner.generics() {
997 self.generics(generics);
1000 // Propagate a trait method's documentation to all implementors of the
1002 if let clean::TraitItem(ref t) = item.inner {
1003 self.traits.entry(item.def_id).or_insert_with(|| t.clone());
1006 // Collect all the implementors of traits.
1007 if let clean::ImplItem(ref i) = item.inner {
1008 if let Some(did) = i.trait_.def_id() {
1009 self.implementors.entry(did).or_insert(vec![]).push(Implementor {
1010 def_id: item.def_id,
1011 stability: item.stability.clone(),
1017 // Index this method for searching later on.
1018 if let Some(ref s) = item.name {
1019 let (parent, is_inherent_impl_item) = match item.inner {
1020 clean::StrippedItem(..) => ((None, None), false),
1021 clean::AssociatedConstItem(..) |
1022 clean::TypedefItem(_, true) if self.parent_is_trait_impl => {
1023 // skip associated items in trait impls
1024 ((None, None), false)
1026 clean::AssociatedTypeItem(..) |
1027 clean::TyMethodItem(..) |
1028 clean::StructFieldItem(..) |
1029 clean::VariantItem(..) => {
1030 ((Some(*self.parent_stack.last().unwrap()),
1031 Some(&self.stack[..self.stack.len() - 1])),
1034 clean::MethodItem(..) | clean::AssociatedConstItem(..) => {
1035 if self.parent_stack.is_empty() {
1036 ((None, None), false)
1038 let last = self.parent_stack.last().unwrap();
1040 let path = match self.paths.get(&did) {
1041 // The current stack not necessarily has correlation
1042 // for where the type was defined. On the other
1043 // hand, `paths` always has the right
1044 // information if present.
1045 Some(&(ref fqp, ItemType::Trait)) |
1046 Some(&(ref fqp, ItemType::Struct)) |
1047 Some(&(ref fqp, ItemType::Union)) |
1048 Some(&(ref fqp, ItemType::Enum)) =>
1049 Some(&fqp[..fqp.len() - 1]),
1050 Some(..) => Some(&*self.stack),
1053 ((Some(*last), path), true)
1056 _ => ((None, Some(&*self.stack)), false)
1060 (parent, Some(path)) if is_inherent_impl_item || (!self.stripped_mod) => {
1061 debug_assert!(!item.is_stripped());
1063 // A crate has a module at its root, containing all items,
1064 // which should not be indexed. The crate-item itself is
1065 // inserted later on when serializing the search-index.
1066 if item.def_id.index != CRATE_DEF_INDEX {
1067 self.search_index.push(IndexItem {
1069 name: s.to_string(),
1070 path: path.join("::").to_string(),
1071 desc: plain_summary_line(item.doc_value()),
1074 search_type: get_index_search_type(&item),
1078 (Some(parent), None) if is_inherent_impl_item => {
1079 // We have a parent, but we don't know where they're
1080 // defined yet. Wait for later to index this item.
1081 self.orphan_impl_items.push((parent, item.clone()));
1087 // Keep track of the fully qualified path for this item.
1088 let pushed = match item.name {
1089 Some(ref n) if !n.is_empty() => {
1090 self.stack.push(n.to_string());
1097 clean::StructItem(..) | clean::EnumItem(..) |
1098 clean::TypedefItem(..) | clean::TraitItem(..) |
1099 clean::FunctionItem(..) | clean::ModuleItem(..) |
1100 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
1101 clean::ConstantItem(..) | clean::StaticItem(..) |
1102 clean::UnionItem(..)
1103 if !self.stripped_mod => {
1104 // Reexported items mean that the same id can show up twice
1105 // in the rustdoc ast that we're looking at. We know,
1106 // however, that a reexported item doesn't show up in the
1107 // `public_items` map, so we can skip inserting into the
1108 // paths map if there was already an entry present and we're
1109 // not a public item.
1111 !self.paths.contains_key(&item.def_id) ||
1112 self.access_levels.is_public(item.def_id)
1114 self.paths.insert(item.def_id,
1115 (self.stack.clone(), item.type_()));
1118 // Link variants to their parent enum because pages aren't emitted
1119 // for each variant.
1120 clean::VariantItem(..) if !self.stripped_mod => {
1121 let mut stack = self.stack.clone();
1123 self.paths.insert(item.def_id, (stack, ItemType::Enum));
1126 clean::PrimitiveItem(..) if item.visibility.is_some() => {
1127 self.paths.insert(item.def_id, (self.stack.clone(),
1134 // Maintain the parent stack
1135 let orig_parent_is_trait_impl = self.parent_is_trait_impl;
1136 let parent_pushed = match item.inner {
1137 clean::TraitItem(..) | clean::EnumItem(..) |
1138 clean::StructItem(..) | clean::UnionItem(..) => {
1139 self.parent_stack.push(item.def_id);
1140 self.parent_is_trait_impl = false;
1143 clean::ImplItem(ref i) => {
1144 self.parent_is_trait_impl = i.trait_.is_some();
1146 clean::ResolvedPath{ did, .. } => {
1147 self.parent_stack.push(did);
1151 let prim_did = t.primitive_type().and_then(|t| {
1152 self.primitive_locations.get(&t).cloned()
1156 self.parent_stack.push(did);
1167 // Once we've recursively found all the generics, hoard off all the
1168 // implementations elsewhere.
1169 let ret = self.fold_item_recur(item).and_then(|item| {
1170 if let clean::Item { inner: clean::ImplItem(_), .. } = item {
1171 // Figure out the id of this impl. This may map to a
1172 // primitive rather than always to a struct/enum.
1173 // Note: matching twice to restrict the lifetime of the `i` borrow.
1174 let did = if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
1176 clean::ResolvedPath { did, .. } |
1177 clean::BorrowedRef {
1178 type_: box clean::ResolvedPath { did, .. }, ..
1183 t.primitive_type().and_then(|t| {
1184 self.primitive_locations.get(&t).cloned()
1191 if let Some(did) = did {
1192 self.impls.entry(did).or_insert(vec![]).push(Impl {
1202 if pushed { self.stack.pop().unwrap(); }
1203 if parent_pushed { self.parent_stack.pop().unwrap(); }
1204 self.stripped_mod = orig_stripped_mod;
1205 self.parent_is_trait_impl = orig_parent_is_trait_impl;
1211 fn generics(&mut self, generics: &clean::Generics) {
1212 for typ in &generics.type_params {
1213 self.typarams.insert(typ.did, typ.name.clone());
1219 /// String representation of how to get back to the root path of the 'doc/'
1220 /// folder in terms of a relative URL.
1221 fn root_path(&self) -> String {
1222 repeat("../").take(self.current.len()).collect::<String>()
1225 /// Recurse in the directory structure and change the "root path" to make
1226 /// sure it always points to the top (relatively).
1227 fn recurse<T, F>(&mut self, s: String, f: F) -> T where
1228 F: FnOnce(&mut Context) -> T,
1231 panic!("Unexpected empty destination: {:?}", self.current);
1233 let prev = self.dst.clone();
1235 self.current.push(s);
1237 info!("Recursing into {}", self.dst.display());
1241 info!("Recursed; leaving {}", self.dst.display());
1243 // Go back to where we were at
1245 self.current.pop().unwrap();
1250 /// Main method for rendering a crate.
1252 /// This currently isn't parallelized, but it'd be pretty easy to add
1253 /// parallelization to this function.
1254 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1255 let mut item = match krate.module.take() {
1257 None => return Ok(()),
1259 item.name = Some(krate.name);
1261 // Render the crate documentation
1262 let mut work = vec![(self, item)];
1264 while let Some((mut cx, item)) = work.pop() {
1265 cx.item(item, |cx, item| {
1266 work.push((cx.clone(), item))
1272 fn render_item(&self,
1273 writer: &mut io::Write,
1277 // A little unfortunate that this is done like this, but it sure
1278 // does make formatting *a lot* nicer.
1279 CURRENT_LOCATION_KEY.with(|slot| {
1280 *slot.borrow_mut() = self.current.clone();
1283 let mut title = if it.is_primitive() {
1284 // No need to include the namespace for primitive types
1287 self.current.join("::")
1290 if !title.is_empty() {
1291 title.push_str("::");
1293 title.push_str(it.name.as_ref().unwrap());
1295 title.push_str(" - Rust");
1296 let tyname = it.type_().css_class();
1297 let desc = if it.is_crate() {
1298 format!("API documentation for the Rust `{}` crate.",
1299 self.shared.layout.krate)
1301 format!("API documentation for the Rust `{}` {} in crate `{}`.",
1302 it.name.as_ref().unwrap(), tyname, self.shared.layout.krate)
1304 let keywords = make_item_keywords(it);
1305 let page = layout::Page {
1307 root_path: &self.root_path(),
1310 keywords: &keywords,
1315 if !self.render_redirect_pages {
1316 layout::render(writer, &self.shared.layout, &page,
1317 &Sidebar{ cx: self, item: it },
1318 &Item{ cx: self, item: it },
1319 self.shared.css_file_extension.is_some())?;
1321 let mut url = self.root_path();
1322 if let Some(&(ref names, ty)) = cache().paths.get(&it.def_id) {
1323 for name in &names[..names.len() - 1] {
1327 url.push_str(&item_path(ty, names.last().unwrap()));
1328 layout::redirect(writer, &url)?;
1334 /// Non-parallelized version of rendering an item. This will take the input
1335 /// item, render its contents, and then invoke the specified closure with
1336 /// all sub-items which need to be rendered.
1338 /// The rendering driver uses this closure to queue up more work.
1339 fn item<F>(&mut self, item: clean::Item, mut f: F) -> Result<(), Error> where
1340 F: FnMut(&mut Context, clean::Item),
1342 // Stripped modules survive the rustdoc passes (i.e. `strip-private`)
1343 // if they contain impls for public types. These modules can also
1344 // contain items such as publicly reexported structures.
1346 // External crates will provide links to these structures, so
1347 // these modules are recursed into, but not rendered normally
1348 // (a flag on the context).
1349 if !self.render_redirect_pages {
1350 self.render_redirect_pages = maybe_ignore_item(&item);
1354 // modules are special because they add a namespace. We also need to
1355 // recurse into the items of the module as well.
1356 let name = item.name.as_ref().unwrap().to_string();
1357 let mut item = Some(item);
1358 self.recurse(name, |this| {
1359 let item = item.take().unwrap();
1361 let mut buf = Vec::new();
1362 this.render_item(&mut buf, &item, false).unwrap();
1363 // buf will be empty if the module is stripped and there is no redirect for it
1364 if !buf.is_empty() {
1365 let joint_dst = this.dst.join("index.html");
1366 try_err!(fs::create_dir_all(&this.dst), &this.dst);
1367 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1368 try_err!(dst.write_all(&buf), &joint_dst);
1371 let m = match item.inner {
1372 clean::StrippedItem(box clean::ModuleItem(m)) |
1373 clean::ModuleItem(m) => m,
1377 // Render sidebar-items.js used throughout this module.
1378 if !this.render_redirect_pages {
1379 let items = this.build_sidebar_items(&m);
1380 let js_dst = this.dst.join("sidebar-items.js");
1381 let mut js_out = BufWriter::new(try_err!(File::create(&js_dst), &js_dst));
1382 try_err!(write!(&mut js_out, "initSidebarItems({});",
1383 as_json(&items)), &js_dst);
1386 for item in m.items {
1392 } else if item.name.is_some() {
1393 let mut buf = Vec::new();
1394 self.render_item(&mut buf, &item, true).unwrap();
1395 // buf will be empty if the item is stripped and there is no redirect for it
1396 if !buf.is_empty() {
1397 let name = item.name.as_ref().unwrap();
1398 let item_type = item.type_();
1399 let file_name = &item_path(item_type, name);
1400 let joint_dst = self.dst.join(file_name);
1401 try_err!(fs::create_dir_all(&self.dst), &self.dst);
1402 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1403 try_err!(dst.write_all(&buf), &joint_dst);
1405 // Redirect from a sane URL using the namespace to Rustdoc's
1406 // URL for the page.
1407 let redir_name = format!("{}.{}.html", name, item_type.name_space());
1408 let redir_dst = self.dst.join(redir_name);
1409 if let Ok(mut redirect_out) = OpenOptions::new().create_new(true)
1412 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1415 // If the item is a macro, redirect from the old macro URL (with !)
1416 // to the new one (without).
1417 // FIXME(#35705) remove this redirect.
1418 if item_type == ItemType::Macro {
1419 let redir_name = format!("{}.{}!.html", item_type, name);
1420 let redir_dst = self.dst.join(redir_name);
1421 let mut redirect_out = try_err!(File::create(&redir_dst), &redir_dst);
1422 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
1429 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
1430 // BTreeMap instead of HashMap to get a sorted output
1431 let mut map = BTreeMap::new();
1432 for item in &m.items {
1433 if maybe_ignore_item(item) { continue }
1435 let short = item.type_().css_class();
1436 let myname = match item.name {
1438 Some(ref s) => s.to_string(),
1440 let short = short.to_string();
1441 map.entry(short).or_insert(vec![])
1442 .push((myname, Some(plain_summary_line(item.doc_value()))));
1445 for (_, items) in &mut map {
1453 /// Generate a url appropriate for an `href` attribute back to the source of
1456 /// The url generated, when clicked, will redirect the browser back to the
1457 /// original source code.
1459 /// If `None` is returned, then a source link couldn't be generated. This
1460 /// may happen, for example, with externally inlined items where the source
1461 /// of their crate documentation isn't known.
1462 fn src_href(&self) -> Option<String> {
1463 let mut root = self.cx.root_path();
1465 let cache = cache();
1466 let mut path = String::new();
1467 let (krate, path) = if self.item.def_id.is_local() {
1468 let path = PathBuf::from(&self.item.source.filename);
1469 if let Some(path) = self.cx.shared.local_sources.get(&path) {
1470 (&self.cx.shared.layout.krate, path)
1475 // Macros from other libraries get special filenames which we can
1477 if self.item.source.filename.starts_with("<") &&
1478 self.item.source.filename.ends_with("macros>") {
1482 let (krate, src_root) = match cache.extern_locations.get(&self.item.def_id.krate) {
1483 Some(&(ref name, ref src, Local)) => (name, src),
1484 Some(&(ref name, ref src, Remote(ref s))) => {
1485 root = s.to_string();
1488 Some(&(_, _, Unknown)) | None => return None,
1491 let file = Path::new(&self.item.source.filename);
1492 clean_srcpath(&src_root, file, false, |component| {
1493 path.push_str(component);
1496 let mut fname = file.file_name().expect("source has no filename")
1498 fname.push(".html");
1499 path.push_str(&fname.to_string_lossy());
1503 let lines = if self.item.source.loline == self.item.source.hiline {
1504 format!("{}", self.item.source.loline)
1506 format!("{}-{}", self.item.source.loline, self.item.source.hiline)
1508 Some(format!("{root}src/{krate}/{path}#{lines}",
1516 impl<'a> fmt::Display for Item<'a> {
1517 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
1518 debug_assert!(!self.item.is_stripped());
1519 // Write the breadcrumb trail header for the top
1520 write!(fmt, "\n<h1 class='fqn'><span class='in-band'>")?;
1521 match self.item.inner {
1522 clean::ModuleItem(ref m) => if m.is_crate {
1523 write!(fmt, "Crate ")?;
1525 write!(fmt, "Module ")?;
1527 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) =>
1528 write!(fmt, "Function ")?,
1529 clean::TraitItem(..) => write!(fmt, "Trait ")?,
1530 clean::StructItem(..) => write!(fmt, "Struct ")?,
1531 clean::UnionItem(..) => write!(fmt, "Union ")?,
1532 clean::EnumItem(..) => write!(fmt, "Enum ")?,
1533 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
1534 clean::MacroItem(..) => write!(fmt, "Macro ")?,
1535 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
1536 clean::StaticItem(..) | clean::ForeignStaticItem(..) =>
1537 write!(fmt, "Static ")?,
1538 clean::ConstantItem(..) => write!(fmt, "Constant ")?,
1540 // We don't generate pages for any other type.
1544 if !self.item.is_primitive() {
1545 let cur = &self.cx.current;
1546 let amt = if self.item.is_mod() { cur.len() - 1 } else { cur.len() };
1547 for (i, component) in cur.iter().enumerate().take(amt) {
1548 write!(fmt, "<a href='{}index.html'>{}</a>::<wbr>",
1549 repeat("../").take(cur.len() - i - 1)
1550 .collect::<String>(),
1554 write!(fmt, "<a class=\"{}\" href=''>{}</a>",
1555 self.item.type_(), self.item.name.as_ref().unwrap())?;
1557 write!(fmt, "</span>")?; // in-band
1558 write!(fmt, "<span class='out-of-band'>")?;
1559 if let Some(version) = self.item.stable_since() {
1560 write!(fmt, "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
1564 r##"<span id='render-detail'>
1565 <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
1566 [<span class='inner'>−</span>]
1572 // When this item is part of a `pub use` in a downstream crate, the
1573 // [src] link in the downstream documentation will actually come back to
1574 // this page, and this link will be auto-clicked. The `id` attribute is
1575 // used to find the link to auto-click.
1576 if self.cx.shared.include_sources && !self.item.is_primitive() {
1577 if let Some(l) = self.src_href() {
1578 write!(fmt, "<a class='srclink' href='{}' title='{}'>[src]</a>",
1579 l, "goto source code")?;
1583 write!(fmt, "</span>")?; // out-of-band
1585 write!(fmt, "</h1>\n")?;
1587 match self.item.inner {
1588 clean::ModuleItem(ref m) => {
1589 item_module(fmt, self.cx, self.item, &m.items)
1591 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) =>
1592 item_function(fmt, self.cx, self.item, f),
1593 clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t),
1594 clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s),
1595 clean::UnionItem(ref s) => item_union(fmt, self.cx, self.item, s),
1596 clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e),
1597 clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t),
1598 clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m),
1599 clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p),
1600 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) =>
1601 item_static(fmt, self.cx, self.item, i),
1602 clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c),
1604 // We don't generate pages for any other type.
1611 fn item_path(ty: ItemType, name: &str) -> String {
1613 ItemType::Module => format!("{}/index.html", name),
1614 _ => format!("{}.{}.html", ty.css_class(), name),
1618 fn full_path(cx: &Context, item: &clean::Item) -> String {
1619 let mut s = cx.current.join("::");
1621 s.push_str(item.name.as_ref().unwrap());
1625 fn shorter<'a>(s: Option<&'a str>) -> String {
1627 Some(s) => s.lines().take_while(|line|{
1628 (*line).chars().any(|chr|{
1629 !chr.is_whitespace()
1631 }).collect::<Vec<_>>().join("\n"),
1632 None => "".to_string()
1637 fn plain_summary_line(s: Option<&str>) -> String {
1638 let line = shorter(s).replace("\n", " ");
1639 markdown::plain_summary_line(&line[..])
1642 fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1643 document_stability(w, cx, item)?;
1644 document_full(w, item, cx.render_type)?;
1648 fn document_short(w: &mut fmt::Formatter, item: &clean::Item, link: AssocItemLink,
1649 render_type: RenderType) -> 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>",
1658 Markdown(&markdown, render_type))?;
1663 fn md_render_assoc_item(item: &clean::Item) -> String {
1665 clean::AssociatedConstItem(ref ty, ref default) => {
1666 if let Some(default) = default.as_ref() {
1667 format!("```\n{}: {:?} = {}\n```\n\n", item.name.as_ref().unwrap(), ty, default)
1669 format!("```\n{}: {:?}\n```\n\n", item.name.as_ref().unwrap(), ty)
1676 fn get_doc_value(item: &clean::Item) -> Option<&str> {
1677 let x = item.doc_value();
1680 clean::AssociatedConstItem(_, _) => Some(""),
1688 fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
1689 render_type: RenderType) -> fmt::Result {
1690 if let Some(s) = get_doc_value(item) {
1691 write!(w, "<div class='docblock'>{}</div>",
1692 Markdown(&format!("{}{}", md_render_assoc_item(item), s), render_type))?;
1697 fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
1698 let stabilities = short_stability(item, cx, true);
1699 if !stabilities.is_empty() {
1700 write!(w, "<div class='stability'>")?;
1701 for stability in stabilities {
1702 write!(w, "{}", stability)?;
1704 write!(w, "</div>")?;
1709 fn name_key(name: &str) -> (&str, u64, usize) {
1710 // find number at end
1711 let split = name.bytes().rposition(|b| b < b'0' || b'9' < b).map_or(0, |s| s + 1);
1713 // count leading zeroes
1715 name[split..].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
1717 // sort leading zeroes last
1718 let num_zeroes = after_zeroes - split;
1720 match name[split..].parse() {
1721 Ok(n) => (&name[..split], n, num_zeroes),
1722 Err(_) => (name, 0, num_zeroes),
1726 fn item_module(w: &mut fmt::Formatter, cx: &Context,
1727 item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
1728 document(w, cx, item)?;
1730 let mut indices = (0..items.len()).filter(|i| {
1731 if let clean::DefaultImplItem(..) = items[*i].inner {
1734 !maybe_ignore_item(&items[*i])
1735 }).collect::<Vec<usize>>();
1737 // the order of item types in the listing
1738 fn reorder(ty: ItemType) -> u8 {
1740 ItemType::ExternCrate => 0,
1741 ItemType::Import => 1,
1742 ItemType::Primitive => 2,
1743 ItemType::Module => 3,
1744 ItemType::Macro => 4,
1745 ItemType::Struct => 5,
1746 ItemType::Enum => 6,
1747 ItemType::Constant => 7,
1748 ItemType::Static => 8,
1749 ItemType::Trait => 9,
1750 ItemType::Function => 10,
1751 ItemType::Typedef => 12,
1752 ItemType::Union => 13,
1757 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
1758 let ty1 = i1.type_();
1759 let ty2 = i2.type_();
1761 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2))
1763 let s1 = i1.stability.as_ref().map(|s| s.level);
1764 let s2 = i2.stability.as_ref().map(|s| s.level);
1766 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
1767 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
1770 let lhs = i1.name.as_ref().map_or("", |s| &**s);
1771 let rhs = i2.name.as_ref().map_or("", |s| &**s);
1772 name_key(lhs).cmp(&name_key(rhs))
1775 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
1777 debug!("{:?}", indices);
1778 let mut curty = None;
1779 for &idx in &indices {
1780 let myitem = &items[idx];
1781 if myitem.is_stripped() {
1785 let myty = Some(myitem.type_());
1786 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
1787 // Put `extern crate` and `use` re-exports in the same section.
1789 } else if myty != curty {
1790 if curty.is_some() {
1791 write!(w, "</table>")?;
1794 let (short, name) = match myty.unwrap() {
1795 ItemType::ExternCrate |
1796 ItemType::Import => ("reexports", "Reexports"),
1797 ItemType::Module => ("modules", "Modules"),
1798 ItemType::Struct => ("structs", "Structs"),
1799 ItemType::Union => ("unions", "Unions"),
1800 ItemType::Enum => ("enums", "Enums"),
1801 ItemType::Function => ("functions", "Functions"),
1802 ItemType::Typedef => ("types", "Type Definitions"),
1803 ItemType::Static => ("statics", "Statics"),
1804 ItemType::Constant => ("constants", "Constants"),
1805 ItemType::Trait => ("traits", "Traits"),
1806 ItemType::Impl => ("impls", "Implementations"),
1807 ItemType::TyMethod => ("tymethods", "Type Methods"),
1808 ItemType::Method => ("methods", "Methods"),
1809 ItemType::StructField => ("fields", "Struct Fields"),
1810 ItemType::Variant => ("variants", "Variants"),
1811 ItemType::Macro => ("macros", "Macros"),
1812 ItemType::Primitive => ("primitives", "Primitive Types"),
1813 ItemType::AssociatedType => ("associated-types", "Associated Types"),
1814 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
1816 write!(w, "<h2 id='{id}' class='section-header'>\
1817 <a href=\"#{id}\">{name}</a></h2>\n<table>",
1818 id = derive_id(short.to_owned()), name = name)?;
1821 match myitem.inner {
1822 clean::ExternCrateItem(ref name, ref src) => {
1823 use html::format::HRef;
1827 write!(w, "<tr><td><code>{}extern crate {} as {};",
1828 VisSpace(&myitem.visibility),
1829 HRef::new(myitem.def_id, src),
1833 write!(w, "<tr><td><code>{}extern crate {};",
1834 VisSpace(&myitem.visibility),
1835 HRef::new(myitem.def_id, name))?
1838 write!(w, "</code></td></tr>")?;
1841 clean::ImportItem(ref import) => {
1842 write!(w, "<tr><td><code>{}{}</code></td></tr>",
1843 VisSpace(&myitem.visibility), *import)?;
1847 if myitem.name.is_none() { continue }
1849 let stabilities = short_stability(myitem, cx, false);
1851 let stab_docs = if !stabilities.is_empty() {
1853 .map(|s| format!("[{}]", s))
1854 .collect::<Vec<_>>()
1861 let unsafety_flag = match myitem.inner {
1862 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
1863 if func.unsafety == hir::Unsafety::Unsafe => {
1864 "<a title='unsafe function' href='#'><sup>âš </sup></a>"
1869 let doc_value = myitem.doc_value().unwrap_or("");
1871 <tr class='{stab} module-item'>
1872 <td><a class=\"{class}\" href=\"{href}\"
1873 title='{title_type} {title}'>{name}</a>{unsafety_flag}</td>
1874 <td class='docblock-short'>
1878 name = *myitem.name.as_ref().unwrap(),
1879 stab_docs = stab_docs,
1880 docs = if cx.render_type == RenderType::Hoedown {
1882 shorter(Some(&Markdown(doc_value,
1883 RenderType::Hoedown).to_string())))
1885 format!("{}", MarkdownSummaryLine(doc_value))
1887 class = myitem.type_(),
1888 stab = myitem.stability_class().unwrap_or("".to_string()),
1889 unsafety_flag = unsafety_flag,
1890 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
1891 title_type = myitem.type_(),
1892 title = full_path(cx, myitem))?;
1897 if curty.is_some() {
1898 write!(w, "</table>")?;
1903 fn maybe_ignore_item(it: &clean::Item) -> bool {
1905 clean::StrippedItem(..) => true,
1906 clean::ModuleItem(ref m) => {
1907 it.doc_value().is_none() && m.items.is_empty()
1908 && it.visibility != Some(clean::Public)
1914 fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
1915 let mut stability = vec![];
1917 if let Some(stab) = item.stability.as_ref() {
1918 let deprecated_reason = if show_reason && !stab.deprecated_reason.is_empty() {
1919 format!(": {}", stab.deprecated_reason)
1923 if !stab.deprecated_since.is_empty() {
1924 let since = if show_reason {
1925 format!(" since {}", Escape(&stab.deprecated_since))
1929 let text = format!("Deprecated{}{}",
1931 MarkdownHtml(&deprecated_reason, cx.render_type));
1932 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1935 if stab.level == stability::Unstable {
1937 let unstable_extra = match (!stab.feature.is_empty(),
1938 &cx.shared.issue_tracker_base_url,
1940 (true, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1941 format!(" (<code>{} </code><a href=\"{}{}\">#{}</a>)",
1942 Escape(&stab.feature), tracker_url, issue_no, issue_no),
1943 (false, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
1944 format!(" (<a href=\"{}{}\">#{}</a>)", Escape(&tracker_url), issue_no,
1947 format!(" (<code>{}</code>)", Escape(&stab.feature)),
1950 if stab.unstable_reason.is_empty() {
1951 stability.push(format!("<div class='stab unstable'>\
1952 <span class=microscope>🔬</span> \
1953 This is a nightly-only experimental API. {}\
1957 let text = format!("<summary><span class=microscope>🔬</span> \
1958 This is a nightly-only experimental API. {}\
1961 MarkdownHtml(&stab.unstable_reason, cx.render_type));
1962 stability.push(format!("<div class='stab unstable'><details>{}</details></div>",
1966 stability.push(format!("<div class='stab unstable'>Experimental</div>"))
1969 } else if let Some(depr) = item.deprecation.as_ref() {
1970 let note = if show_reason && !depr.note.is_empty() {
1971 format!(": {}", depr.note)
1975 let since = if show_reason && !depr.since.is_empty() {
1976 format!(" since {}", Escape(&depr.since))
1981 let text = format!("Deprecated{}{}", since, MarkdownHtml(¬e, cx.render_type));
1982 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
1988 struct Initializer<'a>(&'a str);
1990 impl<'a> fmt::Display for Initializer<'a> {
1991 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1992 let Initializer(s) = *self;
1993 if s.is_empty() { return Ok(()); }
1994 write!(f, "<code> = </code>")?;
1995 write!(f, "<code>{}</code>", Escape(s))
1999 fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2000 c: &clean::Constant) -> fmt::Result {
2001 write!(w, "<pre class='rust const'>")?;
2002 render_attributes(w, it)?;
2003 write!(w, "{vis}const \
2004 {name}: {typ}{init}</pre>",
2005 vis = VisSpace(&it.visibility),
2006 name = it.name.as_ref().unwrap(),
2008 init = Initializer(&c.expr))?;
2012 fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2013 s: &clean::Static) -> fmt::Result {
2014 write!(w, "<pre class='rust static'>")?;
2015 render_attributes(w, it)?;
2016 write!(w, "{vis}static {mutability}\
2017 {name}: {typ}{init}</pre>",
2018 vis = VisSpace(&it.visibility),
2019 mutability = MutableSpace(s.mutability),
2020 name = it.name.as_ref().unwrap(),
2022 init = Initializer(&s.expr))?;
2026 fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2027 f: &clean::Function) -> fmt::Result {
2028 // FIXME(#24111): remove when `const_fn` is stabilized
2029 let vis_constness = match UnstableFeatures::from_environment() {
2030 UnstableFeatures::Allow => f.constness,
2031 _ => hir::Constness::NotConst
2033 let name_len = format!("{}{}{}{:#}fn {}{:#}",
2034 VisSpace(&it.visibility),
2035 ConstnessSpace(vis_constness),
2036 UnsafetySpace(f.unsafety),
2038 it.name.as_ref().unwrap(),
2040 write!(w, "<pre class='rust fn'>")?;
2041 render_attributes(w, it)?;
2042 write!(w, "{vis}{constness}{unsafety}{abi}fn \
2043 {name}{generics}{decl}{where_clause}</pre>",
2044 vis = VisSpace(&it.visibility),
2045 constness = ConstnessSpace(vis_constness),
2046 unsafety = UnsafetySpace(f.unsafety),
2047 abi = AbiSpace(f.abi),
2048 name = it.name.as_ref().unwrap(),
2049 generics = f.generics,
2050 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2059 fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2060 t: &clean::Trait) -> fmt::Result {
2061 let mut bounds = String::new();
2062 let mut bounds_plain = String::new();
2063 if !t.bounds.is_empty() {
2064 if !bounds.is_empty() {
2066 bounds_plain.push(' ');
2068 bounds.push_str(": ");
2069 bounds_plain.push_str(": ");
2070 for (i, p) in t.bounds.iter().enumerate() {
2072 bounds.push_str(" + ");
2073 bounds_plain.push_str(" + ");
2075 bounds.push_str(&format!("{}", *p));
2076 bounds_plain.push_str(&format!("{:#}", *p));
2080 // Output the trait definition
2081 write!(w, "<pre class='rust trait'>")?;
2082 render_attributes(w, it)?;
2083 write!(w, "{}{}trait {}{}{}",
2084 VisSpace(&it.visibility),
2085 UnsafetySpace(t.unsafety),
2086 it.name.as_ref().unwrap(),
2090 if !t.generics.where_predicates.is_empty() {
2091 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true })?;
2096 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2097 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2098 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2099 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2101 if t.items.is_empty() {
2102 write!(w, "{{ }}")?;
2104 // FIXME: we should be using a derived_id for the Anchors here
2108 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2111 if !types.is_empty() && !consts.is_empty() {
2116 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2119 if !consts.is_empty() && !required.is_empty() {
2122 for m in &required {
2124 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2127 if !required.is_empty() && !provided.is_empty() {
2130 for m in &provided {
2132 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2134 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2135 write!(w, ",\n {{ ... }}\n")?;
2138 write!(w, " {{ ... }}\n")?;
2144 write!(w, "</pre>")?;
2146 // Trait documentation
2147 document(w, cx, it)?;
2149 fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item, t: &clean::Item)
2151 let name = m.name.as_ref().unwrap();
2152 let item_type = m.type_();
2153 let id = derive_id(format!("{}.{}", item_type, name));
2154 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2155 write!(w, "<h3 id='{id}' class='method'>\
2156 <span id='{ns_id}' class='invisible'><code>",
2159 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl)?;
2160 write!(w, "</code>")?;
2161 render_stability_since(w, m, t)?;
2162 write!(w, "</span></h3>")?;
2163 document(w, cx, m)?;
2167 if !types.is_empty() {
2169 <h2 id='associated-types'>Associated Types</h2>
2170 <div class='methods'>
2173 trait_item(w, cx, *t, it)?;
2175 write!(w, "</div>")?;
2178 if !consts.is_empty() {
2180 <h2 id='associated-const'>Associated Constants</h2>
2181 <div class='methods'>
2184 trait_item(w, cx, *t, it)?;
2186 write!(w, "</div>")?;
2189 // Output the documentation for each function individually
2190 if !required.is_empty() {
2192 <h2 id='required-methods'>Required Methods</h2>
2193 <div class='methods'>
2195 for m in &required {
2196 trait_item(w, cx, *m, it)?;
2198 write!(w, "</div>")?;
2200 if !provided.is_empty() {
2202 <h2 id='provided-methods'>Provided Methods</h2>
2203 <div class='methods'>
2205 for m in &provided {
2206 trait_item(w, cx, *m, it)?;
2208 write!(w, "</div>")?;
2211 // If there are methods directly on this trait object, render them here.
2212 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2214 let cache = cache();
2216 <h2 id='implementors'>Implementors</h2>
2217 <ul class='item-list' id='implementors-list'>
2219 if let Some(implementors) = cache.implementors.get(&it.def_id) {
2220 // The DefId is for the first Type found with that name. The bool is
2221 // if any Types with the same name but different DefId have been found.
2222 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap();
2223 for implementor in implementors {
2224 match implementor.impl_.for_ {
2225 clean::ResolvedPath { ref path, did, is_generic: false, .. } |
2226 clean::BorrowedRef {
2227 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2230 let &mut (prev_did, ref mut has_duplicates) =
2231 implementor_dups.entry(path.last_name()).or_insert((did, false));
2232 if prev_did != did {
2233 *has_duplicates = true;
2240 for implementor in implementors {
2241 write!(w, "<li><code>")?;
2242 // If there's already another implementor that has the same abbridged name, use the
2243 // full path, for example in `std::iter::ExactSizeIterator`
2244 let use_absolute = match implementor.impl_.for_ {
2245 clean::ResolvedPath { ref path, is_generic: false, .. } |
2246 clean::BorrowedRef {
2247 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2249 } => implementor_dups[path.last_name()].1,
2252 fmt_impl_for_trait_page(&implementor.impl_, w, use_absolute)?;
2253 writeln!(w, "</code></li>")?;
2256 write!(w, "</ul>")?;
2257 write!(w, r#"<script type="text/javascript" async
2258 src="{root_path}/implementors/{path}/{ty}.{name}.js">
2260 root_path = vec![".."; cx.current.len()].join("/"),
2261 path = if it.def_id.is_local() {
2262 cx.current.join("/")
2264 let (ref path, _) = cache.external_paths[&it.def_id];
2265 path[..path.len() - 1].join("/")
2267 ty = it.type_().css_class(),
2268 name = *it.name.as_ref().unwrap())?;
2272 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink) -> String {
2273 use html::item_type::ItemType::*;
2275 let name = it.name.as_ref().unwrap();
2276 let ty = match it.type_() {
2277 Typedef | AssociatedType => AssociatedType,
2281 let anchor = format!("#{}.{}", ty, name);
2283 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2284 AssocItemLink::Anchor(None) => anchor,
2285 AssocItemLink::GotoSource(did, _) => {
2286 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
2291 fn assoc_const(w: &mut fmt::Formatter,
2294 _default: Option<&String>,
2295 link: AssocItemLink) -> fmt::Result {
2296 write!(w, "const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
2297 naive_assoc_href(it, link),
2298 it.name.as_ref().unwrap(),
2303 fn assoc_type(w: &mut fmt::Formatter, it: &clean::Item,
2304 bounds: &Vec<clean::TyParamBound>,
2305 default: Option<&clean::Type>,
2306 link: AssocItemLink) -> fmt::Result {
2307 write!(w, "type <a href='{}' class=\"type\">{}</a>",
2308 naive_assoc_href(it, link),
2309 it.name.as_ref().unwrap())?;
2310 if !bounds.is_empty() {
2311 write!(w, ": {}", TyParamBounds(bounds))?
2313 if let Some(default) = default {
2314 write!(w, " = {}", default)?;
2319 fn render_stability_since_raw<'a>(w: &mut fmt::Formatter,
2320 ver: Option<&'a str>,
2321 containing_ver: Option<&'a str>) -> fmt::Result {
2322 if let Some(v) = ver {
2323 if containing_ver != ver && v.len() > 0 {
2324 write!(w, "<div class='since' title='Stable since Rust version {0}'>{0}</div>",
2331 fn render_stability_since(w: &mut fmt::Formatter,
2333 containing_item: &clean::Item) -> fmt::Result {
2334 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
2337 fn render_assoc_item(w: &mut fmt::Formatter,
2339 link: AssocItemLink,
2340 parent: ItemType) -> fmt::Result {
2341 fn method(w: &mut fmt::Formatter,
2343 unsafety: hir::Unsafety,
2344 constness: hir::Constness,
2346 g: &clean::Generics,
2348 link: AssocItemLink,
2351 let name = meth.name.as_ref().unwrap();
2352 let anchor = format!("#{}.{}", meth.type_(), name);
2353 let href = match link {
2354 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
2355 AssocItemLink::Anchor(None) => anchor,
2356 AssocItemLink::GotoSource(did, provided_methods) => {
2357 // We're creating a link from an impl-item to the corresponding
2358 // trait-item and need to map the anchored type accordingly.
2359 let ty = if provided_methods.contains(name) {
2365 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
2368 // FIXME(#24111): remove when `const_fn` is stabilized
2369 let vis_constness = if is_nightly_build() {
2372 hir::Constness::NotConst
2374 let mut head_len = format!("{}{}{:#}fn {}{:#}",
2375 ConstnessSpace(vis_constness),
2376 UnsafetySpace(unsafety),
2380 let (indent, end_newline) = if parent == ItemType::Trait {
2386 write!(w, "{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
2387 {generics}{decl}{where_clause}",
2388 ConstnessSpace(vis_constness),
2389 UnsafetySpace(unsafety),
2399 where_clause = WhereClause {
2402 end_newline: end_newline,
2406 clean::StrippedItem(..) => Ok(()),
2407 clean::TyMethodItem(ref m) => {
2408 method(w, item, m.unsafety, hir::Constness::NotConst,
2409 m.abi, &m.generics, &m.decl, link, parent)
2411 clean::MethodItem(ref m) => {
2412 method(w, item, m.unsafety, m.constness,
2413 m.abi, &m.generics, &m.decl, link, parent)
2415 clean::AssociatedConstItem(ref ty, ref default) => {
2416 assoc_const(w, item, ty, default.as_ref(), link)
2418 clean::AssociatedTypeItem(ref bounds, ref default) => {
2419 assoc_type(w, item, bounds, default.as_ref(), link)
2421 _ => panic!("render_assoc_item called on non-associated-item")
2425 fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2426 s: &clean::Struct) -> fmt::Result {
2427 write!(w, "<pre class='rust struct'>")?;
2428 render_attributes(w, it)?;
2436 write!(w, "</pre>")?;
2438 document(w, cx, it)?;
2439 let mut fields = s.fields.iter().filter_map(|f| {
2441 clean::StructFieldItem(ref ty) => Some((f, ty)),
2445 if let doctree::Plain = s.struct_type {
2446 if fields.peek().is_some() {
2447 write!(w, "<h2 id='fields' class='fields'>Fields</h2>")?;
2448 for (field, ty) in fields {
2449 let id = derive_id(format!("{}.{}",
2450 ItemType::StructField,
2451 field.name.as_ref().unwrap()));
2452 let ns_id = derive_id(format!("{}.{}",
2453 field.name.as_ref().unwrap(),
2454 ItemType::StructField.name_space()));
2455 write!(w, "<span id='{id}' class=\"{item_type}\">
2456 <span id='{ns_id}' class='invisible'>
2457 <code>{name}: {ty}</code>
2459 item_type = ItemType::StructField,
2462 name = field.name.as_ref().unwrap(),
2464 if let Some(stability_class) = field.stability_class() {
2465 write!(w, "<span class='stab {stab}'></span>",
2466 stab = stability_class)?;
2468 document(w, cx, field)?;
2472 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2475 fn item_union(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2476 s: &clean::Union) -> fmt::Result {
2477 write!(w, "<pre class='rust union'>")?;
2478 render_attributes(w, it)?;
2485 write!(w, "</pre>")?;
2487 document(w, cx, it)?;
2488 let mut fields = s.fields.iter().filter_map(|f| {
2490 clean::StructFieldItem(ref ty) => Some((f, ty)),
2494 if fields.peek().is_some() {
2495 write!(w, "<h2 id='fields' class='fields'>Fields</h2>")?;
2496 for (field, ty) in fields {
2497 write!(w, "<span id='{shortty}.{name}' class=\"{shortty}\"><code>{name}: {ty}</code>
2499 shortty = ItemType::StructField,
2500 name = field.name.as_ref().unwrap(),
2502 if let Some(stability_class) = field.stability_class() {
2503 write!(w, "<span class='stab {stab}'></span>",
2504 stab = stability_class)?;
2506 document(w, cx, field)?;
2509 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
2512 fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2513 e: &clean::Enum) -> fmt::Result {
2514 write!(w, "<pre class='rust enum'>")?;
2515 render_attributes(w, it)?;
2516 write!(w, "{}enum {}{}{}",
2517 VisSpace(&it.visibility),
2518 it.name.as_ref().unwrap(),
2520 WhereClause { gens: &e.generics, indent: 0, end_newline: true })?;
2521 if e.variants.is_empty() && !e.variants_stripped {
2522 write!(w, " {{}}")?;
2524 write!(w, " {{\n")?;
2525 for v in &e.variants {
2527 let name = v.name.as_ref().unwrap();
2529 clean::VariantItem(ref var) => {
2531 clean::VariantKind::CLike => write!(w, "{}", name)?,
2532 clean::VariantKind::Tuple(ref tys) => {
2533 write!(w, "{}(", name)?;
2534 for (i, ty) in tys.iter().enumerate() {
2536 write!(w, ", ")?
2538 write!(w, "{}", *ty)?;
2542 clean::VariantKind::Struct(ref s) => {
2558 if e.variants_stripped {
2559 write!(w, " // some variants omitted\n")?;
2563 write!(w, "</pre>")?;
2565 document(w, cx, it)?;
2566 if !e.variants.is_empty() {
2567 write!(w, "<h2 id='variants' class='variants'>Variants</h2>\n")?;
2568 for variant in &e.variants {
2569 let id = derive_id(format!("{}.{}",
2571 variant.name.as_ref().unwrap()));
2572 let ns_id = derive_id(format!("{}.{}",
2573 variant.name.as_ref().unwrap(),
2574 ItemType::Variant.name_space()));
2575 write!(w, "<span id='{id}' class='variant'>\
2576 <span id='{ns_id}' class='invisible'><code>{name}",
2579 name = variant.name.as_ref().unwrap())?;
2580 if let clean::VariantItem(ref var) = variant.inner {
2581 if let clean::VariantKind::Tuple(ref tys) = var.kind {
2583 for (i, ty) in tys.iter().enumerate() {
2585 write!(w, ", ")?;
2587 write!(w, "{}", *ty)?;
2592 write!(w, "</code></span></span>")?;
2593 document(w, cx, variant)?;
2595 use clean::{Variant, VariantKind};
2596 if let clean::VariantItem(Variant {
2597 kind: VariantKind::Struct(ref s)
2598 }) = variant.inner {
2599 let variant_id = derive_id(format!("{}.{}.fields",
2601 variant.name.as_ref().unwrap()));
2602 write!(w, "<span class='docblock autohide sub-variant' id='{id}'>",
2604 write!(w, "<h3 class='fields'>Fields of <code>{name}</code></h3>\n
2605 <table>", name = variant.name.as_ref().unwrap())?;
2606 for field in &s.fields {
2607 use clean::StructFieldItem;
2608 if let StructFieldItem(ref ty) = field.inner {
2609 let id = derive_id(format!("variant.{}.field.{}",
2610 variant.name.as_ref().unwrap(),
2611 field.name.as_ref().unwrap()));
2612 let ns_id = derive_id(format!("{}.{}.{}.{}",
2613 variant.name.as_ref().unwrap(),
2614 ItemType::Variant.name_space(),
2615 field.name.as_ref().unwrap(),
2616 ItemType::StructField.name_space()));
2617 write!(w, "<tr><td \
2619 <span id='{ns_id}' class='invisible'>\
2620 <code>{f}: {t}</code></span></td><td>",
2623 f = field.name.as_ref().unwrap(),
2625 document(w, cx, field)?;
2626 write!(w, "</td></tr>")?;
2629 write!(w, "</table></span>")?;
2631 render_stability_since(w, variant, it)?;
2634 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2638 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
2639 let name = attr.name();
2642 Some(format!("{}", name))
2643 } else if let Some(v) = attr.value_str() {
2644 Some(format!("{} = {:?}", name, v.as_str()))
2645 } else if let Some(values) = attr.meta_item_list() {
2646 let display: Vec<_> = values.iter().filter_map(|attr| {
2647 attr.meta_item().and_then(|mi| render_attribute(mi))
2650 if display.len() > 0 {
2651 Some(format!("{}({})", name, display.join(", ")))
2660 const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
2667 "unsafe_destructor_blind_to_params"
2670 fn render_attributes(w: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
2671 let mut attrs = String::new();
2673 for attr in &it.attrs.other_attrs {
2674 let name = attr.name().unwrap();
2675 if !ATTRIBUTE_WHITELIST.contains(&&*name.as_str()) {
2678 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
2679 attrs.push_str(&format!("#[{}]\n", s));
2682 if attrs.len() > 0 {
2683 write!(w, "<div class=\"docblock attributes\">{}</div>", &attrs)?;
2688 fn render_struct(w: &mut fmt::Formatter, it: &clean::Item,
2689 g: Option<&clean::Generics>,
2690 ty: doctree::StructType,
2691 fields: &[clean::Item],
2693 structhead: bool) -> fmt::Result {
2695 VisSpace(&it.visibility),
2696 if structhead {"struct "} else {""},
2697 it.name.as_ref().unwrap())?;
2698 if let Some(g) = g {
2703 if let Some(g) = g {
2704 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?
2706 let mut has_visible_fields = false;
2708 for field in fields {
2709 if let clean::StructFieldItem(ref ty) = field.inner {
2710 write!(w, "\n{} {}{}: {},",
2712 VisSpace(&field.visibility),
2713 field.name.as_ref().unwrap(),
2715 has_visible_fields = true;
2719 if has_visible_fields {
2720 if it.has_stripped_fields().unwrap() {
2721 write!(w, "\n{} // some fields omitted", tab)?;
2723 write!(w, "\n{}", tab)?;
2724 } else if it.has_stripped_fields().unwrap() {
2725 // If there are no visible fields we can just display
2726 // `{ /* fields omitted */ }` to save space.
2727 write!(w, " /* fields omitted */ ")?;
2733 for (i, field) in fields.iter().enumerate() {
2738 clean::StrippedItem(box clean::StructFieldItem(..)) => {
2741 clean::StructFieldItem(ref ty) => {
2742 write!(w, "{}{}", VisSpace(&field.visibility), *ty)?
2748 if let Some(g) = g {
2749 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2754 // Needed for PhantomData.
2755 if let Some(g) = g {
2756 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
2764 fn render_union(w: &mut fmt::Formatter, it: &clean::Item,
2765 g: Option<&clean::Generics>,
2766 fields: &[clean::Item],
2768 structhead: bool) -> fmt::Result {
2770 VisSpace(&it.visibility),
2771 if structhead {"union "} else {""},
2772 it.name.as_ref().unwrap())?;
2773 if let Some(g) = g {
2774 write!(w, "{}", g)?;
2775 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?;
2778 write!(w, " {{\n{}", tab)?;
2779 for field in fields {
2780 if let clean::StructFieldItem(ref ty) = field.inner {
2781 write!(w, " {}{}: {},\n{}",
2782 VisSpace(&field.visibility),
2783 field.name.as_ref().unwrap(),
2789 if it.has_stripped_fields().unwrap() {
2790 write!(w, " // some fields omitted\n{}", tab)?;
2796 #[derive(Copy, Clone)]
2797 enum AssocItemLink<'a> {
2798 Anchor(Option<&'a str>),
2799 GotoSource(DefId, &'a FxHashSet<String>),
2802 impl<'a> AssocItemLink<'a> {
2803 fn anchor(&self, id: &'a String) -> Self {
2805 AssocItemLink::Anchor(_) => { AssocItemLink::Anchor(Some(&id)) },
2806 ref other => *other,
2811 enum AssocItemRender<'a> {
2813 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool }
2816 #[derive(Copy, Clone, PartialEq)]
2819 ForDeref { mut_: bool },
2822 fn render_assoc_items(w: &mut fmt::Formatter,
2824 containing_item: &clean::Item,
2826 what: AssocItemRender) -> fmt::Result {
2828 let v = match c.impls.get(&it) {
2830 None => return Ok(()),
2832 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| {
2833 i.inner_impl().trait_.is_none()
2835 if !non_trait.is_empty() {
2836 let render_mode = match what {
2837 AssocItemRender::All => {
2838 write!(w, "<h2 id='methods'>Methods</h2>")?;
2841 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
2842 write!(w, "<h2 id='deref-methods'>Methods from \
2843 {}<Target = {}></h2>", trait_, type_)?;
2844 RenderMode::ForDeref { mut_: deref_mut_ }
2847 for i in &non_trait {
2848 render_impl(w, cx, i, AssocItemLink::Anchor(None), render_mode,
2849 containing_item.stable_since())?;
2852 if let AssocItemRender::DerefFor { .. } = what {
2855 if !traits.is_empty() {
2856 let deref_impl = traits.iter().find(|t| {
2857 t.inner_impl().trait_.def_id() == c.deref_trait_did
2859 if let Some(impl_) = deref_impl {
2860 let has_deref_mut = traits.iter().find(|t| {
2861 t.inner_impl().trait_.def_id() == c.deref_mut_trait_did
2863 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut)?;
2865 write!(w, "<h2 id='implementations'>Trait \
2866 Implementations</h2>")?;
2868 let did = i.trait_did().unwrap();
2869 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2870 render_impl(w, cx, i, assoc_link,
2871 RenderMode::Normal, containing_item.stable_since())?;
2877 fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl,
2878 container_item: &clean::Item, deref_mut: bool) -> fmt::Result {
2879 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
2880 let target = impl_.inner_impl().items.iter().filter_map(|item| {
2882 clean::TypedefItem(ref t, true) => Some(&t.type_),
2885 }).next().expect("Expected associated type binding");
2886 let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target,
2887 deref_mut_: deref_mut };
2888 if let Some(did) = target.def_id() {
2889 render_assoc_items(w, cx, container_item, did, what)
2891 if let Some(prim) = target.primitive_type() {
2892 if let Some(&did) = cache().primitive_locations.get(&prim) {
2893 render_assoc_items(w, cx, container_item, did, what)?;
2900 fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink,
2901 render_mode: RenderMode, outer_version: Option<&str>) -> fmt::Result {
2902 if render_mode == RenderMode::Normal {
2903 write!(w, "<h3 class='impl'><span class='in-band'><code>{}</code>", i.inner_impl())?;
2904 write!(w, "</span><span class='out-of-band'>")?;
2905 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
2906 if let Some(l) = (Item { item: &i.impl_item, cx: cx }).src_href() {
2907 write!(w, "<div class='ghost'></div>")?;
2908 render_stability_since_raw(w, since, outer_version)?;
2909 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2910 l, "goto source code")?;
2912 render_stability_since_raw(w, since, outer_version)?;
2914 write!(w, "</span>")?;
2915 write!(w, "</h3>\n")?;
2916 if let Some(ref dox) = i.impl_item.doc_value() {
2917 write!(w, "<div class='docblock'>{}</div>", Markdown(dox, cx.render_type))?;
2921 fn doc_impl_item(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
2922 link: AssocItemLink, render_mode: RenderMode,
2923 is_default_item: bool, outer_version: Option<&str>,
2924 trait_: Option<&clean::Trait>) -> fmt::Result {
2925 let item_type = item.type_();
2926 let name = item.name.as_ref().unwrap();
2928 let render_method_item: bool = match render_mode {
2929 RenderMode::Normal => true,
2930 RenderMode::ForDeref { mut_: deref_mut_ } => {
2931 let self_type_opt = match item.inner {
2932 clean::MethodItem(ref method) => method.decl.self_type(),
2933 clean::TyMethodItem(ref method) => method.decl.self_type(),
2937 if let Some(self_ty) = self_type_opt {
2938 let by_mut_ref = match self_ty {
2939 SelfTy::SelfBorrowed(_lifetime, mutability) => {
2940 mutability == Mutability::Mutable
2942 SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
2943 mutability == Mutability::Mutable
2948 deref_mut_ || !by_mut_ref
2956 clean::MethodItem(..) | clean::TyMethodItem(..) => {
2957 // Only render when the method is not static or we allow static methods
2958 if render_method_item {
2959 let id = derive_id(format!("{}.{}", item_type, name));
2960 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2961 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2962 write!(w, "<span id='{}' class='invisible'>", ns_id)?;
2963 write!(w, "<code>")?;
2964 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl)?;
2965 write!(w, "</code>")?;
2966 render_stability_since_raw(w, item.stable_since(), outer_version)?;
2967 write!(w, "</span></h4>\n")?;
2970 clean::TypedefItem(ref tydef, _) => {
2971 let id = derive_id(format!("{}.{}", ItemType::AssociatedType, name));
2972 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2973 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2974 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2975 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id))?;
2976 write!(w, "</code></span></h4>\n")?;
2978 clean::AssociatedConstItem(ref ty, ref default) => {
2979 let id = derive_id(format!("{}.{}", item_type, name));
2980 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2981 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2982 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2983 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id))?;
2984 write!(w, "</code></span></h4>\n")?;
2986 clean::ConstantItem(ref c) => {
2987 let id = derive_id(format!("{}.{}", item_type, name));
2988 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2989 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2990 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2991 assoc_const(w, item, &c.type_, Some(&c.expr), link.anchor(&id))?;
2992 write!(w, "</code></span></h4>\n")?;
2994 clean::AssociatedTypeItem(ref bounds, ref default) => {
2995 let id = derive_id(format!("{}.{}", item_type, name));
2996 let ns_id = derive_id(format!("{}.{}", name, item_type.name_space()));
2997 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
2998 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
2999 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id))?;
3000 write!(w, "</code></span></h4>\n")?;
3002 clean::StrippedItem(..) => return Ok(()),
3003 _ => panic!("can't make docs for trait item with name {:?}", item.name)
3006 if render_method_item || render_mode == RenderMode::Normal {
3007 if !is_default_item {
3008 if let Some(t) = trait_ {
3009 // The trait item may have been stripped so we might not
3010 // find any documentation or stability for it.
3011 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
3012 // We need the stability of the item from the trait
3013 // because impls can't have a stability.
3014 document_stability(w, cx, it)?;
3015 if get_doc_value(item).is_some() {
3016 document_full(w, item, cx.render_type)?;
3018 // In case the item isn't documented,
3019 // provide short documentation from the trait.
3020 document_short(w, it, link, cx.render_type)?;
3024 document(w, cx, item)?;
3027 document_stability(w, cx, item)?;
3028 document_short(w, item, link, cx.render_type)?;
3034 let traits = &cache().traits;
3035 let trait_ = i.trait_did().and_then(|did| traits.get(&did));
3037 write!(w, "<div class='impl-items'>")?;
3038 for trait_item in &i.inner_impl().items {
3039 doc_impl_item(w, cx, trait_item, link, render_mode,
3040 false, outer_version, trait_)?;
3043 fn render_default_items(w: &mut fmt::Formatter,
3047 render_mode: RenderMode,
3048 outer_version: Option<&str>) -> fmt::Result {
3049 for trait_item in &t.items {
3050 let n = trait_item.name.clone();
3051 if i.items.iter().find(|m| m.name == n).is_some() {
3054 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3055 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3057 doc_impl_item(w, cx, trait_item, assoc_link, render_mode, true,
3058 outer_version, None)?;
3063 // If we've implemented a trait, then also emit documentation for all
3064 // default items which weren't overridden in the implementation block.
3065 if let Some(t) = trait_ {
3066 render_default_items(w, cx, t, &i.inner_impl(), render_mode, outer_version)?;
3068 write!(w, "</div>")?;
3072 fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3073 t: &clean::Typedef) -> fmt::Result {
3074 write!(w, "<pre class='rust typedef'>")?;
3075 render_attributes(w, it)?;
3076 write!(w, "type {}{}{where_clause} = {type_};</pre>",
3077 it.name.as_ref().unwrap(),
3079 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
3085 impl<'a> fmt::Display for Sidebar<'a> {
3086 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3089 let parentlen = cx.current.len() - if it.is_mod() {1} else {0};
3091 if it.is_struct() || it.is_trait() || it.is_primitive() || it.is_union()
3092 || it.is_enum() || it.is_mod()
3094 write!(fmt, "<p class='location'>")?;
3096 clean::StructItem(..) => write!(fmt, "Struct ")?,
3097 clean::TraitItem(..) => write!(fmt, "Trait ")?,
3098 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
3099 clean::UnionItem(..) => write!(fmt, "Union ")?,
3100 clean::EnumItem(..) => write!(fmt, "Enum ")?,
3101 clean::ModuleItem(..) => if it.is_crate() {
3102 write!(fmt, "Crate ")?;
3104 write!(fmt, "Module ")?;
3108 write!(fmt, "{}", it.name.as_ref().unwrap())?;
3109 write!(fmt, "</p>")?;
3112 clean::StructItem(ref s) => sidebar_struct(fmt, it, s)?,
3113 clean::TraitItem(ref t) => sidebar_trait(fmt, it, t)?,
3114 clean::PrimitiveItem(ref p) => sidebar_primitive(fmt, it, p)?,
3115 clean::UnionItem(ref u) => sidebar_union(fmt, it, u)?,
3116 clean::EnumItem(ref e) => sidebar_enum(fmt, it, e)?,
3117 clean::ModuleItem(ref m) => sidebar_module(fmt, it, &m.items)?,
3122 // The sidebar is designed to display sibling functions, modules and
3123 // other miscellaneous information. since there are lots of sibling
3124 // items (and that causes quadratic growth in large modules),
3125 // we refactor common parts into a shared JavaScript file per module.
3126 // still, we don't move everything into JS because we want to preserve
3127 // as much HTML as possible in order to allow non-JS-enabled browsers
3128 // to navigate the documentation (though slightly inefficiently).
3130 write!(fmt, "<p class='location'>")?;
3131 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
3133 write!(fmt, "::<wbr>")?;
3135 write!(fmt, "<a href='{}index.html'>{}</a>",
3136 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
3139 write!(fmt, "</p>")?;
3141 // Sidebar refers to the enclosing module, not this module.
3142 let relpath = if it.is_mod() { "../" } else { "" };
3144 "<script>window.sidebarCurrent = {{\
3149 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
3150 ty = it.type_().css_class(),
3153 // There is no sidebar-items.js beyond the crate root path
3154 // FIXME maybe dynamic crate loading can be merged here
3156 write!(fmt, "<script defer src=\"{path}sidebar-items.js\"></script>",
3164 fn sidebar_assoc_items(it: &clean::Item) -> String {
3165 let mut out = String::new();
3167 if let Some(v) = c.impls.get(&it.def_id) {
3168 if v.iter().any(|i| i.inner_impl().trait_.is_none()) {
3169 out.push_str("<li><a href=\"#methods\">Methods</a></li>");
3172 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
3173 if let Some(impl_) = v.iter()
3174 .filter(|i| i.inner_impl().trait_.is_some())
3175 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did) {
3176 if let Some(target) = impl_.inner_impl().items.iter().filter_map(|item| {
3178 clean::TypedefItem(ref t, true) => Some(&t.type_),
3182 let inner_impl = target.def_id().or(target.primitive_type().and_then(|prim| {
3183 c.primitive_locations.get(&prim).cloned()
3184 })).and_then(|did| c.impls.get(&did));
3185 if inner_impl.is_some() {
3186 out.push_str("<li><a href=\"#deref-methods\">");
3187 out.push_str(&format!("Methods from {:#}<Target={:#}>",
3188 impl_.inner_impl().trait_.as_ref().unwrap(),
3190 out.push_str("</a></li>");
3194 out.push_str("<li><a href=\"#implementations\">Trait Implementations</a></li>");
3201 fn sidebar_struct(fmt: &mut fmt::Formatter, it: &clean::Item,
3202 s: &clean::Struct) -> fmt::Result {
3203 let mut sidebar = String::new();
3206 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3207 if let doctree::Plain = s.struct_type {
3208 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3212 sidebar.push_str(&sidebar_assoc_items(it));
3214 if !sidebar.is_empty() {
3215 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3220 fn sidebar_trait(fmt: &mut fmt::Formatter, it: &clean::Item,
3221 t: &clean::Trait) -> fmt::Result {
3222 let mut sidebar = String::new();
3224 let has_types = t.items.iter().any(|m| m.is_associated_type());
3225 let has_consts = t.items.iter().any(|m| m.is_associated_const());
3226 let has_required = t.items.iter().any(|m| m.is_ty_method());
3227 let has_provided = t.items.iter().any(|m| m.is_method());
3230 sidebar.push_str("<li><a href=\"#associated-types\">Associated Types</a></li>");
3233 sidebar.push_str("<li><a href=\"#associated-const\">Associated Constants</a></li>");
3236 sidebar.push_str("<li><a href=\"#required-methods\">Required Methods</a></li>");
3239 sidebar.push_str("<li><a href=\"#provided-methods\">Provided Methods</a></li>");
3242 sidebar.push_str(&sidebar_assoc_items(it));
3244 sidebar.push_str("<li><a href=\"#implementors\">Implementors</a></li>");
3246 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)
3249 fn sidebar_primitive(fmt: &mut fmt::Formatter, it: &clean::Item,
3250 _p: &clean::PrimitiveType) -> fmt::Result {
3251 let sidebar = sidebar_assoc_items(it);
3253 if !sidebar.is_empty() {
3254 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3259 fn sidebar_union(fmt: &mut fmt::Formatter, it: &clean::Item,
3260 u: &clean::Union) -> fmt::Result {
3261 let mut sidebar = String::new();
3264 .any(|f| if let clean::StructFieldItem(..) = f.inner { true } else { false }) {
3265 sidebar.push_str("<li><a href=\"#fields\">Fields</a></li>");
3268 sidebar.push_str(&sidebar_assoc_items(it));
3270 if !sidebar.is_empty() {
3271 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3276 fn sidebar_enum(fmt: &mut fmt::Formatter, it: &clean::Item,
3277 e: &clean::Enum) -> fmt::Result {
3278 let mut sidebar = String::new();
3280 if !e.variants.is_empty() {
3281 sidebar.push_str("<li><a href=\"#variants\">Variants</a></li>");
3284 sidebar.push_str(&sidebar_assoc_items(it));
3286 if !sidebar.is_empty() {
3287 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3292 fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
3293 items: &[clean::Item]) -> fmt::Result {
3294 let mut sidebar = String::new();
3296 if items.iter().any(|it| it.type_() == ItemType::ExternCrate ||
3297 it.type_() == ItemType::Import) {
3298 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3300 name = "Reexports"));
3303 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
3304 // to print its headings
3305 for &myty in &[ItemType::Primitive, ItemType::Module, ItemType::Macro, ItemType::Struct,
3306 ItemType::Enum, ItemType::Constant, ItemType::Static, ItemType::Trait,
3307 ItemType::Function, ItemType::Typedef, ItemType::Union, ItemType::Impl,
3308 ItemType::TyMethod, ItemType::Method, ItemType::StructField, ItemType::Variant,
3309 ItemType::AssociatedType, ItemType::AssociatedConst] {
3310 if items.iter().any(|it| {
3311 if let clean::DefaultImplItem(..) = it.inner {
3314 !maybe_ignore_item(it) && !it.is_stripped() && it.type_() == myty
3317 let (short, name) = match myty {
3318 ItemType::ExternCrate |
3319 ItemType::Import => ("reexports", "Reexports"),
3320 ItemType::Module => ("modules", "Modules"),
3321 ItemType::Struct => ("structs", "Structs"),
3322 ItemType::Union => ("unions", "Unions"),
3323 ItemType::Enum => ("enums", "Enums"),
3324 ItemType::Function => ("functions", "Functions"),
3325 ItemType::Typedef => ("types", "Type Definitions"),
3326 ItemType::Static => ("statics", "Statics"),
3327 ItemType::Constant => ("constants", "Constants"),
3328 ItemType::Trait => ("traits", "Traits"),
3329 ItemType::Impl => ("impls", "Implementations"),
3330 ItemType::TyMethod => ("tymethods", "Type Methods"),
3331 ItemType::Method => ("methods", "Methods"),
3332 ItemType::StructField => ("fields", "Struct Fields"),
3333 ItemType::Variant => ("variants", "Variants"),
3334 ItemType::Macro => ("macros", "Macros"),
3335 ItemType::Primitive => ("primitives", "Primitive Types"),
3336 ItemType::AssociatedType => ("associated-types", "Associated Types"),
3337 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
3339 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
3345 if !sidebar.is_empty() {
3346 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
3351 impl<'a> fmt::Display for Source<'a> {
3352 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3353 let Source(s) = *self;
3354 let lines = s.lines().count();
3356 let mut tmp = lines;
3361 write!(fmt, "<pre class=\"line-numbers\">")?;
3362 for i in 1..lines + 1 {
3363 write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
3365 write!(fmt, "</pre>")?;
3366 write!(fmt, "{}", highlight::render_with_highlighting(s, None, None, None))?;
3371 fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3372 t: &clean::Macro) -> fmt::Result {
3373 w.write_str(&highlight::render_with_highlighting(&t.source,
3380 fn item_primitive(w: &mut fmt::Formatter, cx: &Context,
3382 _p: &clean::PrimitiveType) -> fmt::Result {
3383 document(w, cx, it)?;
3384 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3387 const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
3389 fn make_item_keywords(it: &clean::Item) -> String {
3390 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
3393 fn get_index_search_type(item: &clean::Item) -> Option<IndexItemFunctionType> {
3394 let decl = match item.inner {
3395 clean::FunctionItem(ref f) => &f.decl,
3396 clean::MethodItem(ref m) => &m.decl,
3397 clean::TyMethodItem(ref m) => &m.decl,
3401 let inputs = decl.inputs.values.iter().map(|arg| get_index_type(&arg.type_)).collect();
3402 let output = match decl.output {
3403 clean::FunctionRetTy::Return(ref return_type) => Some(get_index_type(return_type)),
3407 Some(IndexItemFunctionType { inputs: inputs, output: output })
3410 fn get_index_type(clean_type: &clean::Type) -> Type {
3411 Type { name: get_index_type_name(clean_type).map(|s| s.to_ascii_lowercase()) }
3414 fn get_index_type_name(clean_type: &clean::Type) -> Option<String> {
3416 clean::ResolvedPath { ref path, .. } => {
3417 let segments = &path.segments;
3418 Some(segments[segments.len() - 1].name.clone())
3420 clean::Generic(ref s) => Some(s.clone()),
3421 clean::Primitive(ref p) => Some(format!("{:?}", p)),
3422 clean::BorrowedRef { ref type_, .. } => get_index_type_name(type_),
3423 // FIXME: add all from clean::Type.
3428 pub fn cache() -> Arc<Cache> {
3429 CACHE_KEY.with(|c| c.borrow().clone())
3434 fn test_unique_id() {
3435 let input = ["foo", "examples", "examples", "method.into_iter","examples",
3436 "method.into_iter", "foo", "main", "search", "methods",
3437 "examples", "method.into_iter", "assoc_type.Item", "assoc_type.Item"];
3438 let expected = ["foo", "examples", "examples-1", "method.into_iter", "examples-2",
3439 "method.into_iter-1", "foo-1", "main-1", "search-1", "methods-1",
3440 "examples-3", "method.into_iter-2", "assoc_type.Item", "assoc_type.Item-1"];
3443 let actual: Vec<String> = input.iter().map(|s| derive_id(s.to_string())).collect();
3444 assert_eq!(&actual[..], expected);
3453 fn test_name_key() {
3454 assert_eq!(name_key("0"), ("", 0, 1));
3455 assert_eq!(name_key("123"), ("", 123, 0));
3456 assert_eq!(name_key("Fruit"), ("Fruit", 0, 0));
3457 assert_eq!(name_key("Fruit0"), ("Fruit", 0, 1));
3458 assert_eq!(name_key("Fruit0000"), ("Fruit", 0, 4));
3459 assert_eq!(name_key("Fruit01"), ("Fruit", 1, 1));
3460 assert_eq!(name_key("Fruit10"), ("Fruit", 10, 0));
3461 assert_eq!(name_key("Fruit123"), ("Fruit", 123, 0));
3466 fn test_name_sorting() {
3467 let names = ["Apple",
3469 "Fruit", "Fruit0", "Fruit00",
3470 "Fruit1", "Fruit01",
3471 "Fruit2", "Fruit02",
3475 let mut sorted = names.to_owned();
3476 sorted.sort_by_key(|&s| name_key(s));
3477 assert_eq!(names, sorted);