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.
36 pub use self::ExternalLocation::*;
39 use std::cell::RefCell;
40 use std::cmp::Ordering;
41 use std::collections::{BTreeMap, VecDeque};
42 use std::default::Default;
44 use std::fmt::{self, Display, Formatter, Write as FmtWrite};
46 use std::fs::{self, File, OpenOptions};
47 use std::io::prelude::*;
48 use std::io::{self, BufWriter, BufReader};
50 use std::path::{PathBuf, Path, Component};
55 use externalfiles::ExternalHtml;
57 use serialize::json::{ToJson, Json, as_json};
59 use syntax::ext::base::MacroKind;
60 use syntax::source_map::FileName;
61 use syntax::feature_gate::UnstableFeatures;
62 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
63 use rustc::middle::privacy::AccessLevels;
64 use rustc::middle::stability;
66 use rustc::util::nodemap::{FxHashMap, FxHashSet};
67 use rustc_data_structures::flock;
69 use clean::{self, AttributesExt, GetDefId, SelfTy, Mutability};
72 use html::escape::Escape;
73 use html::format::{AsyncSpace, ConstnessSpace};
74 use html::format::{GenericBounds, WhereClause, href, AbiSpace};
75 use html::format::{VisSpace, Method, UnsafetySpace, MutableSpace};
76 use html::format::fmt_impl_for_trait_page;
77 use html::item_type::ItemType;
78 use html::markdown::{self, Markdown, MarkdownHtml, MarkdownSummaryLine, ErrorCodes, IdMap};
79 use html::{highlight, layout};
83 /// A pair of name and its optional document.
84 pub type NameDoc = (String, Option<String>);
86 /// Major driving force in all rustdoc rendering. This contains information
87 /// about where in the tree-like hierarchy rendering is occurring and controls
88 /// how the current page is being rendered.
90 /// It is intended that this context is a lightweight object which can be fairly
91 /// easily cloned because it is cloned per work-job (about once per item in the
95 /// Current hierarchy of components leading down to what's currently being
97 pub current: Vec<String>,
98 /// The current destination folder of where HTML artifacts should be placed.
99 /// This changes as the context descends into the module hierarchy.
101 /// A flag, which when `true`, will render pages which redirect to the
102 /// real location of an item. This is used to allow external links to
103 /// publicly reused items to redirect to the right location.
104 pub render_redirect_pages: bool,
105 pub codes: ErrorCodes,
106 /// The map used to ensure all generated 'id=' attributes are unique.
107 id_map: Rc<RefCell<IdMap>>,
108 pub shared: Arc<SharedContext>,
111 struct SharedContext {
112 /// The path to the crate root source minus the file name.
113 /// Used for simplifying paths to the highlighted source code files.
114 pub src_root: PathBuf,
115 /// This describes the layout of each page, and is not modified after
116 /// creation of the context (contains info like the favicon and added html).
117 pub layout: layout::Layout,
118 /// This flag indicates whether `[src]` links should be generated or not. If
119 /// the source files are present in the html rendering, then this will be
121 pub include_sources: bool,
122 /// The local file sources we've emitted and their respective url-paths.
123 pub local_sources: FxHashMap<PathBuf, String>,
124 /// All the passes that were run on this crate.
125 pub passes: FxHashSet<String>,
126 /// The base-URL of the issue tracker for when an item has been tagged with
128 pub issue_tracker_base_url: Option<String>,
129 /// The given user css file which allow to customize the generated
130 /// documentation theme.
131 pub css_file_extension: Option<PathBuf>,
132 /// The directories that have already been created in this doc run. Used to reduce the number
133 /// of spurious `create_dir_all` calls.
134 pub created_dirs: RefCell<FxHashSet<PathBuf>>,
135 /// This flag indicates whether listings of modules (in the side bar and documentation itself)
136 /// should be ordered alphabetically or in order of appearance (in the source code).
137 pub sort_modules_alphabetically: bool,
138 /// Additional themes to be added to the generated docs.
139 pub themes: Vec<PathBuf>,
140 /// Suffix to be added on resource files (if suffix is "-v2" then "light.css" becomes
142 pub resource_suffix: String,
146 fn ensure_dir(&self, dst: &Path) -> io::Result<()> {
147 let mut dirs = self.created_dirs.borrow_mut();
148 if !dirs.contains(dst) {
149 fs::create_dir_all(dst)?;
150 dirs.insert(dst.to_path_buf());
158 /// Returns whether the `collapse-docs` pass was run on this crate.
159 pub fn was_collapsed(&self) -> bool {
160 self.passes.contains("collapse-docs")
163 /// Based on whether the `collapse-docs` pass was run, return either the `doc_value` or the
164 /// `collapsed_doc_value` of the given item.
165 pub fn maybe_collapsed_doc_value<'a>(&self, item: &'a clean::Item) -> Option<Cow<'a, str>> {
166 if self.was_collapsed() {
167 item.collapsed_doc_value().map(|s| s.into())
169 item.doc_value().map(|s| s.into())
174 /// Indicates where an external crate can be found.
175 pub enum ExternalLocation {
176 /// Remote URL root of the external crate
178 /// This external crate can be found in the local doc/ folder
180 /// The external crate could not be found.
184 /// Metadata about implementations for a type or trait.
185 #[derive(Clone, Debug)]
187 pub impl_item: clean::Item,
191 fn inner_impl(&self) -> &clean::Impl {
192 match self.impl_item.inner {
193 clean::ImplItem(ref impl_) => impl_,
194 _ => panic!("non-impl item found in impl")
198 fn trait_did(&self) -> Option<DefId> {
199 self.inner_impl().trait_.def_id()
209 impl error::Error for Error {
210 fn description(&self) -> &str {
211 self.error.description()
215 impl Display for Error {
216 fn fmt(&self, f: &mut Formatter) -> fmt::Result {
217 write!(f, "\"{}\": {}", self.file.display(), self.error)
222 pub fn new(e: io::Error, file: &Path) -> Error {
224 file: file.to_path_buf(),
230 macro_rules! try_none {
231 ($e:expr, $file:expr) => ({
235 None => return Err(Error::new(io::Error::new(io::ErrorKind::Other, "not found"),
241 macro_rules! try_err {
242 ($e:expr, $file:expr) => ({
245 Err(e) => return Err(Error::new(e, $file)),
250 /// This cache is used to store information about the `clean::Crate` being
251 /// rendered in order to provide more useful documentation. This contains
252 /// information like all implementors of a trait, all traits a type implements,
253 /// documentation for all known traits, etc.
255 /// This structure purposefully does not implement `Clone` because it's intended
256 /// to be a fairly large and expensive structure to clone. Instead this adheres
257 /// to `Send` so it may be stored in a `Arc` instance and shared among the various
258 /// rendering threads.
261 /// Mapping of typaram ids to the name of the type parameter. This is used
262 /// when pretty-printing a type (so pretty printing doesn't have to
263 /// painfully maintain a context like this)
264 pub typarams: FxHashMap<DefId, String>,
266 /// Maps a type id to all known implementations for that type. This is only
267 /// recognized for intra-crate `ResolvedPath` types, and is used to print
268 /// out extra documentation on the page of an enum/struct.
270 /// The values of the map are a list of implementations and documentation
271 /// found on that implementation.
272 pub impls: FxHashMap<DefId, Vec<Impl>>,
274 /// Maintains a mapping of local crate node ids to the fully qualified name
275 /// and "short type description" of that node. This is used when generating
276 /// URLs when a type is being linked to. External paths are not located in
277 /// this map because the `External` type itself has all the information
279 pub paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
281 /// Similar to `paths`, but only holds external paths. This is only used for
282 /// generating explicit hyperlinks to other crates.
283 pub external_paths: FxHashMap<DefId, (Vec<String>, ItemType)>,
285 /// Maps local def ids of exported types to fully qualified paths.
286 /// Unlike 'paths', this mapping ignores any renames that occur
287 /// due to 'use' statements.
289 /// This map is used when writing out the special 'implementors'
290 /// javascript file. By using the exact path that the type
291 /// is declared with, we ensure that each path will be identical
292 /// to the path used if the corresponding type is inlined. By
293 /// doing this, we can detect duplicate impls on a trait page, and only display
294 /// the impl for the inlined type.
295 pub exact_paths: FxHashMap<DefId, Vec<String>>,
297 /// This map contains information about all known traits of this crate.
298 /// Implementations of a crate should inherit the documentation of the
299 /// parent trait if no extra documentation is specified, and default methods
300 /// should show up in documentation about trait implementations.
301 pub traits: FxHashMap<DefId, clean::Trait>,
303 /// When rendering traits, it's often useful to be able to list all
304 /// implementors of the trait, and this mapping is exactly, that: a mapping
305 /// of trait ids to the list of known implementors of the trait
306 pub implementors: FxHashMap<DefId, Vec<Impl>>,
308 /// Cache of where external crate documentation can be found.
309 pub extern_locations: FxHashMap<CrateNum, (String, PathBuf, ExternalLocation)>,
311 /// Cache of where documentation for primitives can be found.
312 pub primitive_locations: FxHashMap<clean::PrimitiveType, DefId>,
314 // Note that external items for which `doc(hidden)` applies to are shown as
315 // non-reachable while local items aren't. This is because we're reusing
316 // the access levels from crateanalysis.
317 pub access_levels: AccessLevels<DefId>,
319 /// The version of the crate being documented, if given from the `--crate-version` flag.
320 pub crate_version: Option<String>,
322 // Private fields only used when initially crawling a crate to build a cache
325 parent_stack: Vec<DefId>,
326 parent_is_trait_impl: bool,
327 search_index: Vec<IndexItem>,
329 deref_trait_did: Option<DefId>,
330 deref_mut_trait_did: Option<DefId>,
331 owned_box_did: Option<DefId>,
332 masked_crates: FxHashSet<CrateNum>,
334 // In rare case where a structure is defined in one module but implemented
335 // in another, if the implementing module is parsed before defining module,
336 // then the fully qualified name of the structure isn't presented in `paths`
337 // yet when its implementation methods are being indexed. Caches such methods
338 // and their parent id here and indexes them at the end of crate parsing.
339 orphan_impl_items: Vec<(DefId, clean::Item)>,
341 // Similarly to `orphan_impl_items`, sometimes trait impls are picked up
342 // even though the trait itself is not exported. This can happen if a trait
343 // was defined in function/expression scope, since the impl will be picked
344 // up by `collect-trait-impls` but the trait won't be scraped out in the HIR
345 // crawl. In order to prevent crashes when looking for spotlight traits or
346 // when gathering trait documentation on a type, hold impls here while
347 // folding and add them to the cache later on if we find the trait.
348 orphan_trait_impls: Vec<(DefId, FxHashSet<DefId>, Impl)>,
350 /// Aliases added through `#[doc(alias = "...")]`. Since a few items can have the same alias,
351 /// we need the alias element to have an array of items.
352 aliases: FxHashMap<String, Vec<IndexItem>>,
355 /// Temporary storage for data obtained during `RustdocVisitor::clean()`.
356 /// Later on moved into `CACHE_KEY`.
358 pub struct RenderInfo {
359 pub inlined: FxHashSet<DefId>,
360 pub external_paths: ::core::ExternalPaths,
361 pub external_typarams: FxHashMap<DefId, String>,
362 pub exact_paths: FxHashMap<DefId, Vec<String>>,
363 pub access_levels: AccessLevels<DefId>,
364 pub deref_trait_did: Option<DefId>,
365 pub deref_mut_trait_did: Option<DefId>,
366 pub owned_box_did: Option<DefId>,
369 /// Helper struct to render all source code to HTML pages
370 struct SourceCollector<'a> {
371 scx: &'a mut SharedContext,
373 /// Root destination to place all HTML output into
377 /// Wrapper struct to render the source code of a file. This will do things like
378 /// adding line numbers to the left-hand side.
379 struct Source<'a>(&'a str);
381 // Helper structs for rendering items/sidebars and carrying along contextual
384 #[derive(Copy, Clone)]
387 item: &'a clean::Item,
390 struct Sidebar<'a> { cx: &'a Context, item: &'a clean::Item, }
392 /// Struct representing one entry in the JS search index. These are all emitted
393 /// by hand to a large JS file at the end of cache-creation.
400 parent: Option<DefId>,
401 parent_idx: Option<usize>,
402 search_type: Option<IndexItemFunctionType>,
405 impl ToJson for IndexItem {
406 fn to_json(&self) -> Json {
407 assert_eq!(self.parent.is_some(), self.parent_idx.is_some());
409 let mut data = Vec::with_capacity(6);
410 data.push((self.ty as usize).to_json());
411 data.push(self.name.to_json());
412 data.push(self.path.to_json());
413 data.push(self.desc.to_json());
414 data.push(self.parent_idx.to_json());
415 data.push(self.search_type.to_json());
421 /// A type used for the search index.
424 name: Option<String>,
425 generics: Option<Vec<String>>,
428 impl ToJson for Type {
429 fn to_json(&self) -> Json {
432 let mut data = Vec::with_capacity(2);
433 data.push(name.to_json());
434 if let Some(ref generics) = self.generics {
435 data.push(generics.to_json());
444 /// Full type of functions/methods in the search index.
446 struct IndexItemFunctionType {
448 output: Option<Type>,
451 impl ToJson for IndexItemFunctionType {
452 fn to_json(&self) -> Json {
453 // If we couldn't figure out a type, just write `null`.
454 if self.inputs.iter().chain(self.output.iter()).any(|ref i| i.name.is_none()) {
457 let mut data = Vec::with_capacity(2);
458 data.push(self.inputs.to_json());
459 if let Some(ref output) = self.output {
460 data.push(output.to_json());
467 thread_local!(static CACHE_KEY: RefCell<Arc<Cache>> = Default::default());
468 thread_local!(pub static CURRENT_LOCATION_KEY: RefCell<Vec<String>> = RefCell::new(Vec::new()));
470 pub fn initial_ids() -> Vec<String> {
482 "synthetic-implementors",
484 "synthetic-implementors-list",
488 ].into_iter().map(|id| (String::from(*id))).collect()
491 /// Generates the documentation for `crate` into the directory `dst`
492 pub fn run(mut krate: clean::Crate,
493 extern_urls: BTreeMap<String, String>,
494 external_html: &ExternalHtml,
495 playground_url: Option<String>,
497 resource_suffix: String,
498 passes: FxHashSet<String>,
499 css_file_extension: Option<PathBuf>,
500 renderinfo: RenderInfo,
501 sort_modules_alphabetically: bool,
502 themes: Vec<PathBuf>,
503 enable_minification: bool,
504 id_map: IdMap) -> Result<(), Error> {
505 let src_root = match krate.src {
506 FileName::Real(ref p) => match p.parent() {
507 Some(p) => p.to_path_buf(),
508 None => PathBuf::new(),
512 let mut scx = SharedContext {
515 include_sources: true,
516 local_sources: FxHashMap(),
517 issue_tracker_base_url: None,
518 layout: layout::Layout {
520 favicon: String::new(),
521 external_html: external_html.clone(),
522 krate: krate.name.clone(),
524 css_file_extension: css_file_extension.clone(),
525 created_dirs: RefCell::new(FxHashSet()),
526 sort_modules_alphabetically,
531 // If user passed in `--playground-url` arg, we fill in crate name here
532 if let Some(url) = playground_url {
533 markdown::PLAYGROUND.with(|slot| {
534 *slot.borrow_mut() = Some((Some(krate.name.clone()), url));
538 // Crawl the crate attributes looking for attributes which control how we're
539 // going to emit HTML
540 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
541 for attr in attrs.lists("doc") {
542 let name = attr.name().map(|s| s.as_str());
543 match (name.as_ref().map(|s| &s[..]), attr.value_str()) {
544 (Some("html_favicon_url"), Some(s)) => {
545 scx.layout.favicon = s.to_string();
547 (Some("html_logo_url"), Some(s)) => {
548 scx.layout.logo = s.to_string();
550 (Some("html_playground_url"), Some(s)) => {
551 markdown::PLAYGROUND.with(|slot| {
552 let name = krate.name.clone();
553 *slot.borrow_mut() = Some((Some(name), s.to_string()));
556 (Some("issue_tracker_base_url"), Some(s)) => {
557 scx.issue_tracker_base_url = Some(s.to_string());
559 (Some("html_no_source"), None) if attr.is_word() => {
560 scx.include_sources = false;
566 try_err!(fs::create_dir_all(&dst), &dst);
567 krate = render_sources(&dst, &mut scx, krate)?;
571 render_redirect_pages: false,
572 codes: ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build()),
573 id_map: Rc::new(RefCell::new(id_map)),
574 shared: Arc::new(scx),
577 // Crawl the crate to build various caches used for the output
589 let external_paths = external_paths.into_iter()
590 .map(|(k, (v, t))| (k, (v, ItemType::from(t))))
593 let mut cache = Cache {
598 implementors: FxHashMap(),
600 parent_stack: Vec::new(),
601 search_index: Vec::new(),
602 parent_is_trait_impl: false,
603 extern_locations: FxHashMap(),
604 primitive_locations: FxHashMap(),
607 crate_version: krate.version.take(),
608 orphan_impl_items: Vec::new(),
609 orphan_trait_impls: Vec::new(),
610 traits: krate.external_traits.lock().replace(FxHashMap()),
614 masked_crates: mem::replace(&mut krate.masked_crates, FxHashSet()),
615 typarams: external_typarams,
616 aliases: FxHashMap(),
619 // Cache where all our extern crates are located
620 for &(n, ref e) in &krate.externs {
621 let src_root = match e.src {
622 FileName::Real(ref p) => match p.parent() {
623 Some(p) => p.to_path_buf(),
624 None => PathBuf::new(),
628 let extern_url = extern_urls.get(&e.name).map(|u| &**u);
629 cache.extern_locations.insert(n, (e.name.clone(), src_root,
630 extern_location(e, extern_url, &cx.dst)));
632 let did = DefId { krate: n, index: CRATE_DEF_INDEX };
633 cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
636 // Cache where all known primitives have their documentation located.
638 // Favor linking to as local extern as possible, so iterate all crates in
639 // reverse topological order.
640 for &(_, ref e) in krate.externs.iter().rev() {
641 for &(def_id, prim, _) in &e.primitives {
642 cache.primitive_locations.insert(prim, def_id);
645 for &(def_id, prim, _) in &krate.primitives {
646 cache.primitive_locations.insert(prim, def_id);
649 cache.stack.push(krate.name.clone());
650 krate = cache.fold_crate(krate);
652 for (trait_did, dids, impl_) in cache.orphan_trait_impls.drain(..) {
653 if cache.traits.contains_key(&trait_did) {
655 cache.impls.entry(did).or_insert(vec![]).push(impl_.clone());
660 // Build our search index
661 let index = build_index(&krate, &mut cache);
663 // Freeze the cache now that the index has been built. Put an Arc into TLS
664 // for future parallelization opportunities
665 let cache = Arc::new(cache);
666 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
667 CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear());
669 write_shared(&cx, &krate, &*cache, index, enable_minification)?;
671 // And finally render the whole crate's documentation
675 /// Build the search index from the collected metadata
676 fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
677 let mut nodeid_to_pathid = FxHashMap();
678 let mut crate_items = Vec::with_capacity(cache.search_index.len());
679 let mut crate_paths = Vec::<Json>::new();
681 let Cache { ref mut search_index,
682 ref orphan_impl_items,
683 ref mut paths, .. } = *cache;
685 // Attach all orphan items to the type's definition if the type
686 // has since been learned.
687 for &(did, ref item) in orphan_impl_items {
688 if let Some(&(ref fqp, _)) = paths.get(&did) {
689 search_index.push(IndexItem {
691 name: item.name.clone().unwrap(),
692 path: fqp[..fqp.len() - 1].join("::"),
693 desc: plain_summary_line(item.doc_value()),
696 search_type: get_index_search_type(&item),
701 // Reduce `NodeId` in paths into smaller sequential numbers,
702 // and prune the paths that do not appear in the index.
703 let mut lastpath = String::new();
704 let mut lastpathid = 0usize;
706 for item in search_index {
707 item.parent_idx = item.parent.map(|nodeid| {
708 if nodeid_to_pathid.contains_key(&nodeid) {
709 *nodeid_to_pathid.get(&nodeid).unwrap()
711 let pathid = lastpathid;
712 nodeid_to_pathid.insert(nodeid, pathid);
715 let &(ref fqp, short) = paths.get(&nodeid).unwrap();
716 crate_paths.push(((short as usize), fqp.last().unwrap().clone()).to_json());
721 // Omit the parent path if it is same to that of the prior item.
722 if lastpath == item.path {
725 lastpath = item.path.clone();
727 crate_items.push(item.to_json());
730 let crate_doc = krate.module.as_ref().map(|module| {
731 plain_summary_line(module.doc_value())
732 }).unwrap_or(String::new());
734 let mut crate_data = BTreeMap::new();
735 crate_data.insert("doc".to_owned(), Json::String(crate_doc));
736 crate_data.insert("items".to_owned(), Json::Array(crate_items));
737 crate_data.insert("paths".to_owned(), Json::Array(crate_paths));
739 // Collect the index into a string
740 format!("searchIndex[{}] = {};",
741 as_json(&krate.name),
742 Json::Object(crate_data))
745 fn write_shared(cx: &Context,
746 krate: &clean::Crate,
748 search_index: String,
749 enable_minification: bool) -> Result<(), Error> {
750 // Write out the shared files. Note that these are shared among all rustdoc
751 // docs placed in the output directory, so this needs to be a synchronized
752 // operation with respect to all other rustdocs running around.
753 let _lock = flock::Lock::panicking_new(&cx.dst.join(".lock"), true, true, true);
755 // Add all the static files. These may already exist, but we just
756 // overwrite them anyway to make sure that they're fresh and up-to-date.
758 write_minify(cx.dst.join(&format!("rustdoc{}.css", cx.shared.resource_suffix)),
759 include_str!("static/rustdoc.css"),
760 enable_minification)?;
761 write_minify(cx.dst.join(&format!("settings{}.css", cx.shared.resource_suffix)),
762 include_str!("static/settings.css"),
763 enable_minification)?;
765 // To avoid "light.css" to be overwritten, we'll first run over the received themes and only
766 // then we'll run over the "official" styles.
767 let mut themes: FxHashSet<String> = FxHashSet::default();
769 for entry in &cx.shared.themes {
770 let mut content = Vec::with_capacity(100000);
772 let mut f = try_err!(File::open(&entry), &entry);
773 try_err!(f.read_to_end(&mut content), &entry);
774 let theme = try_none!(try_none!(entry.file_stem(), &entry).to_str(), &entry);
775 let extension = try_none!(try_none!(entry.extension(), &entry).to_str(), &entry);
776 write(cx.dst.join(format!("{}{}.{}", theme, cx.shared.resource_suffix, extension)),
777 content.as_slice())?;
778 themes.insert(theme.to_owned());
781 write(cx.dst.join(&format!("brush{}.svg", cx.shared.resource_suffix)),
782 include_bytes!("static/brush.svg"))?;
783 write(cx.dst.join(&format!("wheel{}.svg", cx.shared.resource_suffix)),
784 include_bytes!("static/wheel.svg"))?;
785 write_minify(cx.dst.join(&format!("light{}.css", cx.shared.resource_suffix)),
786 include_str!("static/themes/light.css"),
787 enable_minification)?;
788 themes.insert("light".to_owned());
789 write_minify(cx.dst.join(&format!("dark{}.css", cx.shared.resource_suffix)),
790 include_str!("static/themes/dark.css"),
791 enable_minification)?;
792 themes.insert("dark".to_owned());
794 let mut themes: Vec<&String> = themes.iter().collect();
796 // To avoid theme switch latencies as much as possible, we put everything theme related
797 // at the beginning of the html files into another js file.
798 write(cx.dst.join(&format!("theme{}.js", cx.shared.resource_suffix)),
800 r#"var themes = document.getElementById("theme-choices");
801 var themePicker = document.getElementById("theme-picker");
803 function switchThemeButtonState() {{
804 if (themes.style.display === "block") {{
805 themes.style.display = "none";
806 themePicker.style.borderBottomRightRadius = "3px";
807 themePicker.style.borderBottomLeftRadius = "3px";
809 themes.style.display = "block";
810 themePicker.style.borderBottomRightRadius = "0";
811 themePicker.style.borderBottomLeftRadius = "0";
815 function handleThemeButtonsBlur(e) {{
816 var active = document.activeElement;
817 var related = e.relatedTarget;
819 if (active.id !== "themePicker" &&
820 (!active.parentNode || active.parentNode.id !== "theme-choices") &&
822 (related.id !== "themePicker" &&
823 (!related.parentNode || related.parentNode.id !== "theme-choices")))) {{
824 switchThemeButtonState();
828 themePicker.onclick = switchThemeButtonState;
829 themePicker.onblur = handleThemeButtonsBlur;
830 [{}].forEach(function(item) {{
831 var but = document.createElement('button');
832 but.innerHTML = item;
833 but.onclick = function(el) {{
834 switchTheme(currentTheme, mainTheme, item);
836 but.onblur = handleThemeButtonsBlur;
837 themes.appendChild(but);
840 .map(|s| format!("\"{}\"", s))
841 .collect::<Vec<String>>()
842 .join(",")).as_bytes(),
845 write_minify(cx.dst.join(&format!("main{}.js", cx.shared.resource_suffix)),
846 include_str!("static/main.js"),
847 enable_minification)?;
848 write_minify(cx.dst.join(&format!("settings{}.js", cx.shared.resource_suffix)),
849 include_str!("static/settings.js"),
850 enable_minification)?;
853 let mut data = format!("var resourcesSuffix = \"{}\";\n",
854 cx.shared.resource_suffix);
855 data.push_str(include_str!("static/storage.js"));
856 write_minify(cx.dst.join(&format!("storage{}.js", cx.shared.resource_suffix)),
858 enable_minification)?;
861 if let Some(ref css) = cx.shared.css_file_extension {
862 let out = cx.dst.join(&format!("theme{}.css", cx.shared.resource_suffix));
863 if !enable_minification {
864 try_err!(fs::copy(css, out), css);
866 let mut f = try_err!(File::open(css), css);
867 let mut buffer = String::with_capacity(1000);
869 try_err!(f.read_to_string(&mut buffer), css);
870 write_minify(out, &buffer, enable_minification)?;
873 write_minify(cx.dst.join(&format!("normalize{}.css", cx.shared.resource_suffix)),
874 include_str!("static/normalize.css"),
875 enable_minification)?;
876 write(cx.dst.join("FiraSans-Regular.woff"),
877 include_bytes!("static/FiraSans-Regular.woff"))?;
878 write(cx.dst.join("FiraSans-Medium.woff"),
879 include_bytes!("static/FiraSans-Medium.woff"))?;
880 write(cx.dst.join("FiraSans-LICENSE.txt"),
881 include_bytes!("static/FiraSans-LICENSE.txt"))?;
882 write(cx.dst.join("Heuristica-Italic.woff"),
883 include_bytes!("static/Heuristica-Italic.woff"))?;
884 write(cx.dst.join("Heuristica-LICENSE.txt"),
885 include_bytes!("static/Heuristica-LICENSE.txt"))?;
886 write(cx.dst.join("SourceSerifPro-Regular.woff"),
887 include_bytes!("static/SourceSerifPro-Regular.woff"))?;
888 write(cx.dst.join("SourceSerifPro-Bold.woff"),
889 include_bytes!("static/SourceSerifPro-Bold.woff"))?;
890 write(cx.dst.join("SourceSerifPro-LICENSE.txt"),
891 include_bytes!("static/SourceSerifPro-LICENSE.txt"))?;
892 write(cx.dst.join("SourceCodePro-Regular.woff"),
893 include_bytes!("static/SourceCodePro-Regular.woff"))?;
894 write(cx.dst.join("SourceCodePro-Semibold.woff"),
895 include_bytes!("static/SourceCodePro-Semibold.woff"))?;
896 write(cx.dst.join("SourceCodePro-LICENSE.txt"),
897 include_bytes!("static/SourceCodePro-LICENSE.txt"))?;
898 write(cx.dst.join("LICENSE-MIT.txt"),
899 include_bytes!("static/LICENSE-MIT.txt"))?;
900 write(cx.dst.join("LICENSE-APACHE.txt"),
901 include_bytes!("static/LICENSE-APACHE.txt"))?;
902 write(cx.dst.join("COPYRIGHT.txt"),
903 include_bytes!("static/COPYRIGHT.txt"))?;
905 fn collect(path: &Path, krate: &str, key: &str) -> io::Result<Vec<String>> {
906 let mut ret = Vec::new();
908 for line in BufReader::new(File::open(path)?).lines() {
910 if !line.starts_with(key) {
913 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
916 ret.push(line.to_string());
922 fn show_item(item: &IndexItem, krate: &str) -> String {
923 format!("{{'crate':'{}','ty':{},'name':'{}','desc':'{}','p':'{}'{}}}",
924 krate, item.ty as usize, item.name, item.desc.replace("'", "\\'"), item.path,
925 if let Some(p) = item.parent_idx {
926 format!(",'parent':{}", p)
932 let dst = cx.dst.join("aliases.js");
934 let mut all_aliases = try_err!(collect(&dst, &krate.name, "ALIASES"), &dst);
935 let mut w = try_err!(File::create(&dst), &dst);
936 let mut output = String::with_capacity(100);
937 for (alias, items) in &cache.aliases {
938 if items.is_empty() {
941 output.push_str(&format!("\"{}\":[{}],",
944 .map(|v| show_item(v, &krate.name))
948 all_aliases.push(format!("ALIASES['{}'] = {{{}}};", krate.name, output));
950 try_err!(writeln!(&mut w, "var ALIASES = {{}};"), &dst);
951 for aliases in &all_aliases {
952 try_err!(writeln!(&mut w, "{}", aliases), &dst);
956 // Update the search index
957 let dst = cx.dst.join("search-index.js");
958 let mut all_indexes = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
959 all_indexes.push(search_index);
960 // Sort the indexes by crate so the file will be generated identically even
961 // with rustdoc running in parallel.
963 let mut w = try_err!(File::create(&dst), &dst);
964 try_err!(writeln!(&mut w, "var N = null;var searchIndex = {{}};"), &dst);
965 for index in &all_indexes {
966 try_err!(write_minify_replacer(&mut w, &*index, enable_minification,
967 &[(minifier::js::Keyword::Null, "N")]),
970 try_err!(writeln!(&mut w, "initSearch(searchIndex);"), &dst);
972 // Update the list of all implementors for traits
973 let dst = cx.dst.join("implementors");
974 for (&did, imps) in &cache.implementors {
975 // Private modules can leak through to this phase of rustdoc, which
976 // could contain implementations for otherwise private types. In some
977 // rare cases we could find an implementation for an item which wasn't
978 // indexed, so we just skip this step in that case.
980 // FIXME: this is a vague explanation for why this can't be a `get`, in
981 // theory it should be...
982 let &(ref remote_path, remote_item_type) = match cache.paths.get(&did) {
984 None => match cache.external_paths.get(&did) {
990 let mut have_impls = false;
991 let mut implementors = format!(r#"implementors["{}"] = ["#, krate.name);
993 // If the trait and implementation are in the same crate, then
994 // there's no need to emit information about it (there's inlining
995 // going on). If they're in different crates then the crate defining
996 // the trait will be interested in our implementation.
997 if imp.impl_item.def_id.krate == did.krate { continue }
998 // If the implementation is from another crate then that crate
1000 if !imp.impl_item.def_id.is_local() { continue }
1002 write!(implementors, "{{text:{},synthetic:{},types:{}}},",
1003 as_json(&imp.inner_impl().to_string()),
1004 imp.inner_impl().synthetic,
1005 as_json(&collect_paths_for_type(imp.inner_impl().for_.clone()))).unwrap();
1007 implementors.push_str("];");
1009 // Only create a js file if we have impls to add to it. If the trait is
1010 // documented locally though we always create the file to avoid dead
1012 if !have_impls && !cache.paths.contains_key(&did) {
1016 let mut mydst = dst.clone();
1017 for part in &remote_path[..remote_path.len() - 1] {
1020 try_err!(fs::create_dir_all(&mydst), &mydst);
1021 mydst.push(&format!("{}.{}.js",
1022 remote_item_type.css_class(),
1023 remote_path[remote_path.len() - 1]));
1025 let mut all_implementors = try_err!(collect(&mydst, &krate.name, "implementors"), &mydst);
1026 all_implementors.push(implementors);
1027 // Sort the implementors by crate so the file will be generated
1028 // identically even with rustdoc running in parallel.
1029 all_implementors.sort();
1031 let mut f = try_err!(File::create(&mydst), &mydst);
1032 try_err!(writeln!(&mut f, "(function() {{var implementors = {{}};"), &mydst);
1033 for implementor in &all_implementors {
1034 try_err!(writeln!(&mut f, "{}", *implementor), &mydst);
1036 try_err!(writeln!(&mut f, "{}", r"
1037 if (window.register_implementors) {
1038 window.register_implementors(implementors);
1040 window.pending_implementors = implementors;
1043 try_err!(writeln!(&mut f, r"}})()"), &mydst);
1048 fn render_sources(dst: &Path, scx: &mut SharedContext,
1049 krate: clean::Crate) -> Result<clean::Crate, Error> {
1050 info!("emitting source files");
1051 let dst = dst.join("src").join(&krate.name);
1052 try_err!(fs::create_dir_all(&dst), &dst);
1053 let mut folder = SourceCollector {
1057 Ok(folder.fold_crate(krate))
1060 /// Writes the entire contents of a string to a destination, not attempting to
1061 /// catch any errors.
1062 fn write(dst: PathBuf, contents: &[u8]) -> Result<(), Error> {
1063 Ok(try_err!(fs::write(&dst, contents), &dst))
1066 fn write_minify(dst: PathBuf, contents: &str, enable_minification: bool) -> Result<(), Error> {
1067 if enable_minification {
1068 if dst.extension() == Some(&OsStr::new("css")) {
1069 let res = try_none!(minifier::css::minify(contents).ok(), &dst);
1070 write(dst, res.as_bytes())
1072 write(dst, minifier::js::minify(contents).as_bytes())
1075 write(dst, contents.as_bytes())
1079 fn write_minify_replacer<W: Write>(dst: &mut W,
1081 enable_minification: bool,
1082 keywords_to_replace: &[(minifier::js::Keyword, &str)])
1084 if enable_minification {
1086 minifier::js::minify_and_replace_keywords(contents, keywords_to_replace))
1088 writeln!(dst, "{}", contents)
1092 /// Takes a path to a source file and cleans the path to it. This canonicalizes
1093 /// things like ".." to components which preserve the "top down" hierarchy of a
1094 /// static HTML tree. Each component in the cleaned path will be passed as an
1095 /// argument to `f`. The very last component of the path (ie the file name) will
1096 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
1097 // FIXME (#9639): The closure should deal with &[u8] instead of &str
1098 // FIXME (#9639): This is too conservative, rejecting non-UTF-8 paths
1099 fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) where
1102 // make it relative, if possible
1103 let p = p.strip_prefix(src_root).unwrap_or(p);
1105 let mut iter = p.components().peekable();
1107 while let Some(c) = iter.next() {
1108 if !keep_filename && iter.peek().is_none() {
1113 Component::ParentDir => f("up"),
1114 Component::Normal(c) => f(c.to_str().unwrap()),
1120 /// Attempts to find where an external crate is located, given that we're
1121 /// rendering in to the specified source destination.
1122 fn extern_location(e: &clean::ExternalCrate, extern_url: Option<&str>, dst: &Path)
1125 // See if there's documentation generated into the local directory
1126 let local_location = dst.join(&e.name);
1127 if local_location.is_dir() {
1131 if let Some(url) = extern_url {
1132 let mut url = url.to_string();
1133 if !url.ends_with("/") {
1139 // Failing that, see if there's an attribute specifying where to find this
1141 e.attrs.lists("doc")
1142 .filter(|a| a.check_name("html_root_url"))
1143 .filter_map(|a| a.value_str())
1145 let mut url = url.to_string();
1146 if !url.ends_with("/") {
1150 }).next().unwrap_or(Unknown) // Well, at least we tried.
1153 impl<'a> DocFolder for SourceCollector<'a> {
1154 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
1155 // If we're including source files, and we haven't seen this file yet,
1156 // then we need to render it out to the filesystem.
1157 if self.scx.include_sources
1158 // skip all invalid or macro spans
1159 && item.source.filename.is_real()
1160 // skip non-local items
1161 && item.def_id.is_local() {
1163 // If it turns out that we couldn't read this file, then we probably
1164 // can't read any of the files (generating html output from json or
1165 // something like that), so just don't include sources for the
1166 // entire crate. The other option is maintaining this mapping on a
1167 // per-file basis, but that's probably not worth it...
1169 .include_sources = match self.emit_source(&item.source.filename) {
1172 println!("warning: source code was requested to be rendered, \
1173 but processing `{}` had an error: {}",
1174 item.source.filename, e);
1175 println!(" skipping rendering of source code");
1180 self.fold_item_recur(item)
1184 impl<'a> SourceCollector<'a> {
1185 /// Renders the given filename into its corresponding HTML source file.
1186 fn emit_source(&mut self, filename: &FileName) -> io::Result<()> {
1187 let p = match *filename {
1188 FileName::Real(ref file) => file,
1191 if self.scx.local_sources.contains_key(&**p) {
1192 // We've already emitted this source
1196 let contents = fs::read_to_string(&p)?;
1198 // Remove the utf-8 BOM if any
1199 let contents = if contents.starts_with("\u{feff}") {
1205 // Create the intermediate directories
1206 let mut cur = self.dst.clone();
1207 let mut root_path = String::from("../../");
1208 let mut href = String::new();
1209 clean_srcpath(&self.scx.src_root, &p, false, |component| {
1210 cur.push(component);
1211 fs::create_dir_all(&cur).unwrap();
1212 root_path.push_str("../");
1213 href.push_str(component);
1216 let mut fname = p.file_name()
1217 .expect("source has no filename")
1219 fname.push(".html");
1221 href.push_str(&fname.to_string_lossy());
1223 let mut w = BufWriter::new(File::create(&cur)?);
1224 let title = format!("{} -- source", cur.file_name().unwrap()
1225 .to_string_lossy());
1226 let desc = format!("Source to the Rust file `{}`.", filename);
1227 let page = layout::Page {
1229 css_class: "source",
1230 root_path: &root_path,
1232 keywords: BASIC_KEYWORDS,
1233 resource_suffix: &self.scx.resource_suffix,
1235 layout::render(&mut w, &self.scx.layout,
1236 &page, &(""), &Source(contents),
1237 self.scx.css_file_extension.is_some(),
1240 self.scx.local_sources.insert(p.clone(), href);
1245 impl DocFolder for Cache {
1246 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
1247 if item.def_id.is_local() {
1248 debug!("folding {} \"{:?}\", id {:?}", item.type_(), item.name, item.def_id);
1251 // If this is a stripped module,
1252 // we don't want it or its children in the search index.
1253 let orig_stripped_mod = match item.inner {
1254 clean::StrippedItem(box clean::ModuleItem(..)) => {
1255 mem::replace(&mut self.stripped_mod, true)
1257 _ => self.stripped_mod,
1260 // If the impl is from a masked crate or references something from a
1261 // masked crate then remove it completely.
1262 if let clean::ImplItem(ref i) = item.inner {
1263 if self.masked_crates.contains(&item.def_id.krate) ||
1264 i.trait_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) ||
1265 i.for_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) {
1270 // Register any generics to their corresponding string. This is used
1271 // when pretty-printing types.
1272 if let Some(generics) = item.inner.generics() {
1273 self.generics(generics);
1276 // Propagate a trait method's documentation to all implementors of the
1278 if let clean::TraitItem(ref t) = item.inner {
1279 self.traits.entry(item.def_id).or_insert_with(|| t.clone());
1282 // Collect all the implementors of traits.
1283 if let clean::ImplItem(ref i) = item.inner {
1284 if let Some(did) = i.trait_.def_id() {
1285 if i.blanket_impl.is_none() {
1286 self.implementors.entry(did).or_default().push(Impl {
1287 impl_item: item.clone(),
1293 // Index this method for searching later on.
1294 if let Some(ref s) = item.name {
1295 let (parent, is_inherent_impl_item) = match item.inner {
1296 clean::StrippedItem(..) => ((None, None), false),
1297 clean::AssociatedConstItem(..) |
1298 clean::TypedefItem(_, true) if self.parent_is_trait_impl => {
1299 // skip associated items in trait impls
1300 ((None, None), false)
1302 clean::AssociatedTypeItem(..) |
1303 clean::TyMethodItem(..) |
1304 clean::StructFieldItem(..) |
1305 clean::VariantItem(..) => {
1306 ((Some(*self.parent_stack.last().unwrap()),
1307 Some(&self.stack[..self.stack.len() - 1])),
1310 clean::MethodItem(..) | clean::AssociatedConstItem(..) => {
1311 if self.parent_stack.is_empty() {
1312 ((None, None), false)
1314 let last = self.parent_stack.last().unwrap();
1316 let path = match self.paths.get(&did) {
1317 // The current stack not necessarily has correlation
1318 // for where the type was defined. On the other
1319 // hand, `paths` always has the right
1320 // information if present.
1321 Some(&(ref fqp, ItemType::Trait)) |
1322 Some(&(ref fqp, ItemType::Struct)) |
1323 Some(&(ref fqp, ItemType::Union)) |
1324 Some(&(ref fqp, ItemType::Enum)) =>
1325 Some(&fqp[..fqp.len() - 1]),
1326 Some(..) => Some(&*self.stack),
1329 ((Some(*last), path), true)
1332 _ => ((None, Some(&*self.stack)), false)
1336 (parent, Some(path)) if is_inherent_impl_item || (!self.stripped_mod) => {
1337 debug_assert!(!item.is_stripped());
1339 // A crate has a module at its root, containing all items,
1340 // which should not be indexed. The crate-item itself is
1341 // inserted later on when serializing the search-index.
1342 if item.def_id.index != CRATE_DEF_INDEX {
1343 self.search_index.push(IndexItem {
1345 name: s.to_string(),
1346 path: path.join("::").to_string(),
1347 desc: plain_summary_line(item.doc_value()),
1350 search_type: get_index_search_type(&item),
1354 (Some(parent), None) if is_inherent_impl_item => {
1355 // We have a parent, but we don't know where they're
1356 // defined yet. Wait for later to index this item.
1357 self.orphan_impl_items.push((parent, item.clone()));
1363 // Keep track of the fully qualified path for this item.
1364 let pushed = match item.name {
1365 Some(ref n) if !n.is_empty() => {
1366 self.stack.push(n.to_string());
1373 clean::StructItem(..) | clean::EnumItem(..) |
1374 clean::TypedefItem(..) | clean::TraitItem(..) |
1375 clean::FunctionItem(..) | clean::ModuleItem(..) |
1376 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
1377 clean::ConstantItem(..) | clean::StaticItem(..) |
1378 clean::UnionItem(..) | clean::ForeignTypeItem | clean::MacroItem(..)
1379 if !self.stripped_mod => {
1380 // Re-exported items mean that the same id can show up twice
1381 // in the rustdoc ast that we're looking at. We know,
1382 // however, that a re-exported item doesn't show up in the
1383 // `public_items` map, so we can skip inserting into the
1384 // paths map if there was already an entry present and we're
1385 // not a public item.
1386 if !self.paths.contains_key(&item.def_id) ||
1387 self.access_levels.is_public(item.def_id)
1389 self.paths.insert(item.def_id,
1390 (self.stack.clone(), item.type_()));
1392 self.add_aliases(&item);
1394 // Link variants to their parent enum because pages aren't emitted
1395 // for each variant.
1396 clean::VariantItem(..) if !self.stripped_mod => {
1397 let mut stack = self.stack.clone();
1399 self.paths.insert(item.def_id, (stack, ItemType::Enum));
1402 clean::PrimitiveItem(..) if item.visibility.is_some() => {
1403 self.add_aliases(&item);
1404 self.paths.insert(item.def_id, (self.stack.clone(),
1411 // Maintain the parent stack
1412 let orig_parent_is_trait_impl = self.parent_is_trait_impl;
1413 let parent_pushed = match item.inner {
1414 clean::TraitItem(..) | clean::EnumItem(..) | clean::ForeignTypeItem |
1415 clean::StructItem(..) | clean::UnionItem(..) => {
1416 self.parent_stack.push(item.def_id);
1417 self.parent_is_trait_impl = false;
1420 clean::ImplItem(ref i) => {
1421 self.parent_is_trait_impl = i.trait_.is_some();
1423 clean::ResolvedPath{ did, .. } => {
1424 self.parent_stack.push(did);
1428 let prim_did = t.primitive_type().and_then(|t| {
1429 self.primitive_locations.get(&t).cloned()
1433 self.parent_stack.push(did);
1444 // Once we've recursively found all the generics, hoard off all the
1445 // implementations elsewhere.
1446 let ret = self.fold_item_recur(item).and_then(|item| {
1447 if let clean::Item { inner: clean::ImplItem(_), .. } = item {
1448 // Figure out the id of this impl. This may map to a
1449 // primitive rather than always to a struct/enum.
1450 // Note: matching twice to restrict the lifetime of the `i` borrow.
1451 let mut dids = FxHashSet();
1452 if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
1454 clean::ResolvedPath { did, .. } |
1455 clean::BorrowedRef {
1456 type_: box clean::ResolvedPath { did, .. }, ..
1461 let did = t.primitive_type().and_then(|t| {
1462 self.primitive_locations.get(&t).cloned()
1465 if let Some(did) = did {
1471 if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
1472 for bound in generics {
1473 if let Some(did) = bound.def_id() {
1481 let impl_item = Impl {
1484 if impl_item.trait_did().map_or(true, |d| self.traits.contains_key(&d)) {
1486 self.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
1489 let trait_did = impl_item.trait_did().unwrap();
1490 self.orphan_trait_impls.push((trait_did, dids, impl_item));
1498 if pushed { self.stack.pop().unwrap(); }
1499 if parent_pushed { self.parent_stack.pop().unwrap(); }
1500 self.stripped_mod = orig_stripped_mod;
1501 self.parent_is_trait_impl = orig_parent_is_trait_impl;
1507 fn generics(&mut self, generics: &clean::Generics) {
1508 for param in &generics.params {
1510 clean::GenericParamDefKind::Lifetime => {}
1511 clean::GenericParamDefKind::Type { did, .. } => {
1512 self.typarams.insert(did, param.name.clone());
1518 fn add_aliases(&mut self, item: &clean::Item) {
1519 if item.def_id.index == CRATE_DEF_INDEX {
1522 if let Some(ref item_name) = item.name {
1523 let path = self.paths.get(&item.def_id)
1524 .map(|p| p.0[..p.0.len() - 1].join("::"))
1525 .unwrap_or("std".to_owned());
1526 for alias in item.attrs.lists("doc")
1527 .filter(|a| a.check_name("alias"))
1528 .filter_map(|a| a.value_str()
1529 .map(|s| s.to_string().replace("\"", "")))
1530 .filter(|v| !v.is_empty())
1531 .collect::<FxHashSet<_>>()
1533 self.aliases.entry(alias)
1534 .or_insert(Vec::with_capacity(1))
1537 name: item_name.to_string(),
1539 desc: plain_summary_line(item.doc_value()),
1542 search_type: get_index_search_type(&item),
1549 #[derive(Debug, Eq, PartialEq, Hash)]
1556 fn new(mut url: String, name: String) -> ItemEntry {
1557 while url.starts_with('/') {
1567 impl fmt::Display for ItemEntry {
1568 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1569 write!(f, "<a href='{}'>{}</a>", self.url, Escape(&self.name))
1573 impl PartialOrd for ItemEntry {
1574 fn partial_cmp(&self, other: &ItemEntry) -> Option<::std::cmp::Ordering> {
1575 Some(self.cmp(other))
1579 impl Ord for ItemEntry {
1580 fn cmp(&self, other: &ItemEntry) -> ::std::cmp::Ordering {
1581 self.name.cmp(&other.name)
1587 structs: FxHashSet<ItemEntry>,
1588 enums: FxHashSet<ItemEntry>,
1589 unions: FxHashSet<ItemEntry>,
1590 primitives: FxHashSet<ItemEntry>,
1591 traits: FxHashSet<ItemEntry>,
1592 macros: FxHashSet<ItemEntry>,
1593 functions: FxHashSet<ItemEntry>,
1594 typedefs: FxHashSet<ItemEntry>,
1595 existentials: FxHashSet<ItemEntry>,
1596 statics: FxHashSet<ItemEntry>,
1597 constants: FxHashSet<ItemEntry>,
1598 keywords: FxHashSet<ItemEntry>,
1599 attributes: FxHashSet<ItemEntry>,
1600 derives: FxHashSet<ItemEntry>,
1604 fn new() -> AllTypes {
1605 let new_set = |cap| FxHashSet::with_capacity_and_hasher(cap, Default::default());
1607 structs: new_set(100),
1608 enums: new_set(100),
1609 unions: new_set(100),
1610 primitives: new_set(26),
1611 traits: new_set(100),
1612 macros: new_set(100),
1613 functions: new_set(100),
1614 typedefs: new_set(100),
1615 existentials: new_set(100),
1616 statics: new_set(100),
1617 constants: new_set(100),
1618 keywords: new_set(100),
1619 attributes: new_set(100),
1620 derives: new_set(100),
1624 fn append(&mut self, item_name: String, item_type: &ItemType) {
1625 let mut url: Vec<_> = item_name.split("::").skip(1).collect();
1626 if let Some(name) = url.pop() {
1627 let new_url = format!("{}/{}.{}.html", url.join("/"), item_type, name);
1629 let name = url.join("::");
1631 ItemType::Struct => self.structs.insert(ItemEntry::new(new_url, name)),
1632 ItemType::Enum => self.enums.insert(ItemEntry::new(new_url, name)),
1633 ItemType::Union => self.unions.insert(ItemEntry::new(new_url, name)),
1634 ItemType::Primitive => self.primitives.insert(ItemEntry::new(new_url, name)),
1635 ItemType::Trait => self.traits.insert(ItemEntry::new(new_url, name)),
1636 ItemType::Macro => self.macros.insert(ItemEntry::new(new_url, name)),
1637 ItemType::Function => self.functions.insert(ItemEntry::new(new_url, name)),
1638 ItemType::Typedef => self.typedefs.insert(ItemEntry::new(new_url, name)),
1639 ItemType::Existential => self.existentials.insert(ItemEntry::new(new_url, name)),
1640 ItemType::Static => self.statics.insert(ItemEntry::new(new_url, name)),
1641 ItemType::Constant => self.constants.insert(ItemEntry::new(new_url, name)),
1642 ItemType::ProcAttribute => self.attributes.insert(ItemEntry::new(new_url, name)),
1643 ItemType::ProcDerive => self.derives.insert(ItemEntry::new(new_url, name)),
1650 fn print_entries(f: &mut fmt::Formatter, e: &FxHashSet<ItemEntry>, title: &str,
1651 class: &str) -> fmt::Result {
1653 let mut e: Vec<&ItemEntry> = e.iter().collect();
1655 write!(f, "<h3 id='{}'>{}</h3><ul class='{} docblock'>{}</ul>",
1659 e.iter().map(|s| format!("<li>{}</li>", s)).collect::<String>())?;
1664 impl fmt::Display for AllTypes {
1665 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1668 <span class='out-of-band'>\
1669 <span id='render-detail'>\
1670 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
1671 [<span class='inner'>−</span>]\
1675 <span class='in-band'>List of all items</span>\
1677 print_entries(f, &self.structs, "Structs", "structs")?;
1678 print_entries(f, &self.enums, "Enums", "enums")?;
1679 print_entries(f, &self.unions, "Unions", "unions")?;
1680 print_entries(f, &self.primitives, "Primitives", "primitives")?;
1681 print_entries(f, &self.traits, "Traits", "traits")?;
1682 print_entries(f, &self.macros, "Macros", "macros")?;
1683 print_entries(f, &self.attributes, "Attribute Macros", "attributes")?;
1684 print_entries(f, &self.derives, "Derive Macros", "derives")?;
1685 print_entries(f, &self.functions, "Functions", "functions")?;
1686 print_entries(f, &self.typedefs, "Typedefs", "typedefs")?;
1687 print_entries(f, &self.existentials, "Existentials", "existentials")?;
1688 print_entries(f, &self.statics, "Statics", "statics")?;
1689 print_entries(f, &self.constants, "Constants", "constants")
1694 struct Settings<'a> {
1695 // (id, explanation, default value)
1696 settings: Vec<(&'static str, &'static str, bool)>,
1701 impl<'a> Settings<'a> {
1702 pub fn new(root_path: &'a str, suffix: &'a str) -> Settings<'a> {
1705 ("item-declarations", "Auto-hide item declarations.", true),
1706 ("item-attributes", "Auto-hide item attributes.", true),
1707 ("trait-implementations", "Auto-hide trait implementations documentation",
1709 ("method-docs", "Auto-hide item methods' documentation", false),
1710 ("go-to-only-result", "Directly go to item in search if there is only one result",
1719 impl<'a> fmt::Display for Settings<'a> {
1720 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1723 <span class='in-band'>Rustdoc settings</span>\
1725 <div class='settings'>{}</div>\
1726 <script src='{}settings{}.js'></script>",
1727 self.settings.iter()
1728 .map(|(id, text, enabled)| {
1729 format!("<div class='setting-line'>\
1730 <label class='toggle'>\
1731 <input type='checkbox' id='{}' {}>\
1732 <span class='slider'></span>\
1735 </div>", id, if *enabled { " checked" } else { "" }, text)
1737 .collect::<String>(),
1744 fn derive_id(&self, id: String) -> String {
1745 let mut map = self.id_map.borrow_mut();
1749 /// String representation of how to get back to the root path of the 'doc/'
1750 /// folder in terms of a relative URL.
1751 fn root_path(&self) -> String {
1752 "../".repeat(self.current.len())
1755 /// Recurse in the directory structure and change the "root path" to make
1756 /// sure it always points to the top (relatively).
1757 fn recurse<T, F>(&mut self, s: String, f: F) -> T where
1758 F: FnOnce(&mut Context) -> T,
1761 panic!("Unexpected empty destination: {:?}", self.current);
1763 let prev = self.dst.clone();
1765 self.current.push(s);
1767 info!("Recursing into {}", self.dst.display());
1771 info!("Recursed; leaving {}", self.dst.display());
1773 // Go back to where we were at
1775 self.current.pop().unwrap();
1780 /// Main method for rendering a crate.
1782 /// This currently isn't parallelized, but it'd be pretty easy to add
1783 /// parallelization to this function.
1784 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1785 let mut item = match krate.module.take() {
1787 None => return Ok(()),
1789 let final_file = self.dst.join(&krate.name)
1791 let settings_file = self.dst.join("settings.html");
1793 let crate_name = krate.name.clone();
1794 item.name = Some(krate.name);
1796 let mut all = AllTypes::new();
1799 // Render the crate documentation
1800 let mut work = vec![(self.clone(), item)];
1802 while let Some((mut cx, item)) = work.pop() {
1803 cx.item(item, &mut all, |cx, item| {
1804 work.push((cx.clone(), item))
1809 let mut w = BufWriter::new(try_err!(File::create(&final_file), &final_file));
1810 let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
1811 if !root_path.ends_with('/') {
1812 root_path.push('/');
1814 let mut page = layout::Page {
1815 title: "List of all items in this crate",
1818 description: "List of all items in this crate",
1819 keywords: BASIC_KEYWORDS,
1820 resource_suffix: &self.shared.resource_suffix,
1822 let sidebar = if let Some(ref version) = cache().crate_version {
1823 format!("<p class='location'>Crate {}</p>\
1824 <div class='block version'>\
1827 <a id='all-types' href='index.html'><p>Back to index</p></a>",
1828 crate_name, version)
1832 try_err!(layout::render(&mut w, &self.shared.layout,
1833 &page, &sidebar, &all,
1834 self.shared.css_file_extension.is_some(),
1835 &self.shared.themes),
1838 // Generating settings page.
1839 let settings = Settings::new("./", &self.shared.resource_suffix);
1840 page.title = "Rustdoc settings";
1841 page.description = "Settings of Rustdoc";
1842 page.root_path = "./";
1844 let mut w = BufWriter::new(try_err!(File::create(&settings_file), &settings_file));
1845 let mut themes = self.shared.themes.clone();
1846 let sidebar = "<p class='location'>Settings</p><div class='sidebar-elems'></div>";
1847 themes.push(PathBuf::from("settings.css"));
1848 let mut layout = self.shared.layout.clone();
1849 layout.krate = String::new();
1850 layout.logo = String::new();
1851 layout.favicon = String::new();
1852 try_err!(layout::render(&mut w, &layout,
1853 &page, &sidebar, &settings,
1854 self.shared.css_file_extension.is_some(),
1861 fn render_item(&self,
1862 writer: &mut dyn io::Write,
1866 // A little unfortunate that this is done like this, but it sure
1867 // does make formatting *a lot* nicer.
1868 CURRENT_LOCATION_KEY.with(|slot| {
1869 *slot.borrow_mut() = self.current.clone();
1872 let mut title = if it.is_primitive() || it.is_keyword() {
1873 // No need to include the namespace for primitive types and keywords
1876 self.current.join("::")
1879 if !title.is_empty() {
1880 title.push_str("::");
1882 title.push_str(it.name.as_ref().unwrap());
1884 title.push_str(" - Rust");
1885 let tyname = it.type_().css_class();
1886 let desc = if it.is_crate() {
1887 format!("API documentation for the Rust `{}` crate.",
1888 self.shared.layout.krate)
1890 format!("API documentation for the Rust `{}` {} in crate `{}`.",
1891 it.name.as_ref().unwrap(), tyname, self.shared.layout.krate)
1893 let keywords = make_item_keywords(it);
1894 let page = layout::Page {
1896 root_path: &self.root_path(),
1899 keywords: &keywords,
1900 resource_suffix: &self.shared.resource_suffix,
1904 self.id_map.borrow_mut().reset();
1905 self.id_map.borrow_mut().populate(initial_ids());
1908 if !self.render_redirect_pages {
1909 layout::render(writer, &self.shared.layout, &page,
1910 &Sidebar{ cx: self, item: it },
1911 &Item{ cx: self, item: it },
1912 self.shared.css_file_extension.is_some(),
1913 &self.shared.themes)?;
1915 let mut url = self.root_path();
1916 if let Some(&(ref names, ty)) = cache().paths.get(&it.def_id) {
1917 for name in &names[..names.len() - 1] {
1921 url.push_str(&item_path(ty, names.last().unwrap()));
1922 layout::redirect(writer, &url)?;
1928 /// Non-parallelized version of rendering an item. This will take the input
1929 /// item, render its contents, and then invoke the specified closure with
1930 /// all sub-items which need to be rendered.
1932 /// The rendering driver uses this closure to queue up more work.
1933 fn item<F>(&mut self, item: clean::Item, all: &mut AllTypes, mut f: F) -> Result<(), Error>
1934 where F: FnMut(&mut Context, clean::Item),
1936 // Stripped modules survive the rustdoc passes (i.e. `strip-private`)
1937 // if they contain impls for public types. These modules can also
1938 // contain items such as publicly re-exported structures.
1940 // External crates will provide links to these structures, so
1941 // these modules are recursed into, but not rendered normally
1942 // (a flag on the context).
1943 if !self.render_redirect_pages {
1944 self.render_redirect_pages = item.is_stripped();
1948 // modules are special because they add a namespace. We also need to
1949 // recurse into the items of the module as well.
1950 let name = item.name.as_ref().unwrap().to_string();
1951 let mut item = Some(item);
1952 self.recurse(name, |this| {
1953 let item = item.take().unwrap();
1955 let mut buf = Vec::new();
1956 this.render_item(&mut buf, &item, false).unwrap();
1957 // buf will be empty if the module is stripped and there is no redirect for it
1958 if !buf.is_empty() {
1959 try_err!(this.shared.ensure_dir(&this.dst), &this.dst);
1960 let joint_dst = this.dst.join("index.html");
1961 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1962 try_err!(dst.write_all(&buf), &joint_dst);
1965 let m = match item.inner {
1966 clean::StrippedItem(box clean::ModuleItem(m)) |
1967 clean::ModuleItem(m) => m,
1971 // Render sidebar-items.js used throughout this module.
1972 if !this.render_redirect_pages {
1973 let items = this.build_sidebar_items(&m);
1974 let js_dst = this.dst.join("sidebar-items.js");
1975 let mut js_out = BufWriter::new(try_err!(File::create(&js_dst), &js_dst));
1976 try_err!(write!(&mut js_out, "initSidebarItems({});",
1977 as_json(&items)), &js_dst);
1980 for item in m.items {
1986 } else if item.name.is_some() {
1987 let mut buf = Vec::new();
1988 self.render_item(&mut buf, &item, true).unwrap();
1989 // buf will be empty if the item is stripped and there is no redirect for it
1990 if !buf.is_empty() {
1991 let name = item.name.as_ref().unwrap();
1992 let item_type = item.type_();
1993 let file_name = &item_path(item_type, name);
1994 try_err!(self.shared.ensure_dir(&self.dst), &self.dst);
1995 let joint_dst = self.dst.join(file_name);
1996 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
1997 try_err!(dst.write_all(&buf), &joint_dst);
1999 if !self.render_redirect_pages {
2000 all.append(full_path(self, &item), &item_type);
2002 // Redirect from a sane URL using the namespace to Rustdoc's
2003 // URL for the page.
2004 let redir_name = format!("{}.{}.html", name, item_type.name_space());
2005 let redir_dst = self.dst.join(redir_name);
2006 if let Ok(redirect_out) = OpenOptions::new().create_new(true)
2009 let mut redirect_out = BufWriter::new(redirect_out);
2010 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
2013 // If the item is a macro, redirect from the old macro URL (with !)
2014 // to the new one (without).
2015 if item_type == ItemType::Macro {
2016 let redir_name = format!("{}.{}!.html", item_type, name);
2017 let redir_dst = self.dst.join(redir_name);
2018 let redirect_out = try_err!(File::create(&redir_dst), &redir_dst);
2019 let mut redirect_out = BufWriter::new(redirect_out);
2020 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
2027 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
2028 // BTreeMap instead of HashMap to get a sorted output
2029 let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
2030 for item in &m.items {
2031 if item.is_stripped() { continue }
2033 let short = item.type_().css_class();
2034 let myname = match item.name {
2036 Some(ref s) => s.to_string(),
2038 let short = short.to_string();
2039 map.entry(short).or_default()
2040 .push((myname, Some(plain_summary_line(item.doc_value()))));
2043 if self.shared.sort_modules_alphabetically {
2044 for (_, items) in &mut map {
2053 /// Generate a url appropriate for an `href` attribute back to the source of
2056 /// The url generated, when clicked, will redirect the browser back to the
2057 /// original source code.
2059 /// If `None` is returned, then a source link couldn't be generated. This
2060 /// may happen, for example, with externally inlined items where the source
2061 /// of their crate documentation isn't known.
2062 fn src_href(&self) -> Option<String> {
2063 let mut root = self.cx.root_path();
2065 let cache = cache();
2066 let mut path = String::new();
2068 // We can safely ignore macros from other libraries
2069 let file = match self.item.source.filename {
2070 FileName::Real(ref path) => path,
2074 let (krate, path) = if self.item.def_id.is_local() {
2075 if let Some(path) = self.cx.shared.local_sources.get(file) {
2076 (&self.cx.shared.layout.krate, path)
2081 let (krate, src_root) = match cache.extern_locations.get(&self.item.def_id.krate) {
2082 Some(&(ref name, ref src, Local)) => (name, src),
2083 Some(&(ref name, ref src, Remote(ref s))) => {
2084 root = s.to_string();
2087 Some(&(_, _, Unknown)) | None => return None,
2090 clean_srcpath(&src_root, file, false, |component| {
2091 path.push_str(component);
2094 let mut fname = file.file_name().expect("source has no filename")
2096 fname.push(".html");
2097 path.push_str(&fname.to_string_lossy());
2101 let lines = if self.item.source.loline == self.item.source.hiline {
2102 self.item.source.loline.to_string()
2104 format!("{}-{}", self.item.source.loline, self.item.source.hiline)
2106 Some(format!("{root}src/{krate}/{path}#{lines}",
2107 root = Escape(&root),
2114 fn wrap_into_docblock<F>(w: &mut fmt::Formatter,
2115 f: F) -> fmt::Result
2116 where F: Fn(&mut fmt::Formatter) -> fmt::Result {
2117 write!(w, "<div class=\"docblock type-decl hidden-by-usual-hider\">")?;
2122 impl<'a> fmt::Display for Item<'a> {
2123 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
2124 debug_assert!(!self.item.is_stripped());
2125 // Write the breadcrumb trail header for the top
2126 write!(fmt, "<h1 class='fqn'><span class='out-of-band'>")?;
2127 if let Some(version) = self.item.stable_since() {
2128 write!(fmt, "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
2132 "<span id='render-detail'>\
2133 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" \
2134 title=\"collapse all docs\">\
2135 [<span class='inner'>−</span>]\
2141 // When this item is part of a `pub use` in a downstream crate, the
2142 // [src] link in the downstream documentation will actually come back to
2143 // this page, and this link will be auto-clicked. The `id` attribute is
2144 // used to find the link to auto-click.
2145 if self.cx.shared.include_sources && !self.item.is_primitive() {
2146 if let Some(l) = self.src_href() {
2147 write!(fmt, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2148 l, "goto source code")?;
2152 write!(fmt, "</span>")?; // out-of-band
2153 write!(fmt, "<span class='in-band'>")?;
2154 match self.item.inner {
2155 clean::ModuleItem(ref m) => if m.is_crate {
2156 write!(fmt, "Crate ")?;
2158 write!(fmt, "Module ")?;
2160 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) => write!(fmt, "Function ")?,
2161 clean::TraitItem(..) => write!(fmt, "Trait ")?,
2162 clean::StructItem(..) => write!(fmt, "Struct ")?,
2163 clean::UnionItem(..) => write!(fmt, "Union ")?,
2164 clean::EnumItem(..) => write!(fmt, "Enum ")?,
2165 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
2166 clean::MacroItem(..) => write!(fmt, "Macro ")?,
2167 clean::ProcMacroItem(ref mac) => match mac.kind {
2168 MacroKind::Bang => write!(fmt, "Macro ")?,
2169 MacroKind::Attr => write!(fmt, "Attribute Macro ")?,
2170 MacroKind::Derive => write!(fmt, "Derive Macro ")?,
2171 MacroKind::ProcMacroStub => unreachable!(),
2173 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
2174 clean::StaticItem(..) | clean::ForeignStaticItem(..) => write!(fmt, "Static ")?,
2175 clean::ConstantItem(..) => write!(fmt, "Constant ")?,
2176 clean::ForeignTypeItem => write!(fmt, "Foreign Type ")?,
2177 clean::KeywordItem(..) => write!(fmt, "Keyword ")?,
2178 clean::ExistentialItem(..) => write!(fmt, "Existential Type ")?,
2180 // We don't generate pages for any other type.
2184 if !self.item.is_primitive() && !self.item.is_keyword() {
2185 let cur = &self.cx.current;
2186 let amt = if self.item.is_mod() { cur.len() - 1 } else { cur.len() };
2187 for (i, component) in cur.iter().enumerate().take(amt) {
2188 write!(fmt, "<a href='{}index.html'>{}</a>::<wbr>",
2189 "../".repeat(cur.len() - i - 1),
2193 write!(fmt, "<a class=\"{}\" href=''>{}</a>",
2194 self.item.type_(), self.item.name.as_ref().unwrap())?;
2196 write!(fmt, "</span></h1>")?; // in-band
2198 match self.item.inner {
2199 clean::ModuleItem(ref m) =>
2200 item_module(fmt, self.cx, self.item, &m.items),
2201 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) =>
2202 item_function(fmt, self.cx, self.item, f),
2203 clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t),
2204 clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s),
2205 clean::UnionItem(ref s) => item_union(fmt, self.cx, self.item, s),
2206 clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e),
2207 clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t),
2208 clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m),
2209 clean::ProcMacroItem(ref m) => item_proc_macro(fmt, self.cx, self.item, m),
2210 clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p),
2211 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) =>
2212 item_static(fmt, self.cx, self.item, i),
2213 clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c),
2214 clean::ForeignTypeItem => item_foreign_type(fmt, self.cx, self.item),
2215 clean::KeywordItem(ref k) => item_keyword(fmt, self.cx, self.item, k),
2216 clean::ExistentialItem(ref e, _) => item_existential(fmt, self.cx, self.item, e),
2218 // We don't generate pages for any other type.
2225 fn item_path(ty: ItemType, name: &str) -> String {
2227 ItemType::Module => format!("{}/index.html", name),
2228 _ => format!("{}.{}.html", ty.css_class(), name),
2232 fn full_path(cx: &Context, item: &clean::Item) -> String {
2233 let mut s = cx.current.join("::");
2235 s.push_str(item.name.as_ref().unwrap());
2239 fn shorter<'a>(s: Option<&'a str>) -> String {
2241 Some(s) => s.lines()
2242 .skip_while(|s| s.chars().all(|c| c.is_whitespace()))
2244 (*line).chars().any(|chr|{
2245 !chr.is_whitespace()
2247 }).collect::<Vec<_>>().join("\n"),
2248 None => String::new()
2253 fn plain_summary_line(s: Option<&str>) -> String {
2254 let line = shorter(s).replace("\n", " ");
2255 markdown::plain_summary_line(&line[..])
2258 fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
2259 if let Some(ref name) = item.name {
2260 info!("Documenting {}", name);
2262 document_stability(w, cx, item)?;
2263 document_full(w, item, cx, "")?;
2267 /// Render md_text as markdown.
2268 fn render_markdown(w: &mut fmt::Formatter,
2271 links: Vec<(String, String)>,
2274 let mut ids = cx.id_map.borrow_mut();
2275 write!(w, "<div class='docblock'>{}{}</div>",
2276 prefix, Markdown(md_text, &links, RefCell::new(&mut ids), cx.codes))
2279 fn document_short(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item, link: AssocItemLink,
2280 prefix: &str) -> fmt::Result {
2281 if let Some(s) = item.doc_value() {
2282 let markdown = if s.contains('\n') {
2283 format!("{} [Read more]({})",
2284 &plain_summary_line(Some(s)), naive_assoc_href(item, link))
2286 plain_summary_line(Some(s)).to_string()
2288 render_markdown(w, cx, &markdown, item.links(), prefix)?;
2289 } else if !prefix.is_empty() {
2290 write!(w, "<div class='docblock'>{}</div>", prefix)?;
2295 fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
2296 cx: &Context, prefix: &str) -> fmt::Result {
2297 if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
2298 debug!("Doc block: =====\n{}\n=====", s);
2299 render_markdown(w, cx, &*s, item.links(), prefix)?;
2300 } else if !prefix.is_empty() {
2301 write!(w, "<div class='docblock'>{}</div>", prefix)?;
2306 fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
2307 let stabilities = short_stability(item, cx, true);
2308 if !stabilities.is_empty() {
2309 write!(w, "<div class='stability'>")?;
2310 for stability in stabilities {
2311 write!(w, "{}", stability)?;
2313 write!(w, "</div>")?;
2318 fn document_non_exhaustive_header(item: &clean::Item) -> &str {
2319 if item.is_non_exhaustive() { " (Non-exhaustive)" } else { "" }
2322 fn document_non_exhaustive(w: &mut fmt::Formatter, item: &clean::Item) -> fmt::Result {
2323 if item.is_non_exhaustive() {
2324 write!(w, "<div class='docblock non-exhaustive non-exhaustive-{}'>", {
2325 if item.is_struct() { "struct" } else if item.is_enum() { "enum" } else { "type" }
2328 if item.is_struct() {
2329 write!(w, "Non-exhaustive structs could have additional fields added in future. \
2330 Therefore, non-exhaustive structs cannot be constructed in external crates \
2331 using the traditional <code>Struct {{ .. }}</code> syntax; cannot be \
2332 matched against without a wildcard <code>..</code>; and \
2333 struct update syntax will not work.")?;
2334 } else if item.is_enum() {
2335 write!(w, "Non-exhaustive enums could have additional variants added in future. \
2336 Therefore, when matching against variants of non-exhaustive enums, an \
2337 extra wildcard arm must be added to account for any future variants.")?;
2339 write!(w, "This type will require a wildcard arm in any match statements or \
2343 write!(w, "</div>")?;
2349 fn name_key(name: &str) -> (&str, u64, usize) {
2350 let end = name.bytes()
2351 .rposition(|b| b.is_ascii_digit()).map_or(name.len(), |i| i + 1);
2353 // find number at end
2354 let split = name[0..end].bytes()
2355 .rposition(|b| !b.is_ascii_digit()).map_or(0, |i| i + 1);
2357 // count leading zeroes
2359 name[split..end].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
2361 // sort leading zeroes last
2362 let num_zeroes = after_zeroes - split;
2364 match name[split..end].parse() {
2365 Ok(n) => (&name[..split], n, num_zeroes),
2366 Err(_) => (name, 0, num_zeroes),
2370 fn item_module(w: &mut fmt::Formatter, cx: &Context,
2371 item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
2372 document(w, cx, item)?;
2374 let mut indices = (0..items.len()).filter(|i| !items[*i].is_stripped()).collect::<Vec<usize>>();
2376 // the order of item types in the listing
2377 fn reorder(ty: ItemType) -> u8 {
2379 ItemType::ExternCrate => 0,
2380 ItemType::Import => 1,
2381 ItemType::Primitive => 2,
2382 ItemType::Module => 3,
2383 ItemType::Macro => 4,
2384 ItemType::Struct => 5,
2385 ItemType::Enum => 6,
2386 ItemType::Constant => 7,
2387 ItemType::Static => 8,
2388 ItemType::Trait => 9,
2389 ItemType::Function => 10,
2390 ItemType::Typedef => 12,
2391 ItemType::Union => 13,
2396 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
2397 let ty1 = i1.type_();
2398 let ty2 = i2.type_();
2400 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2))
2402 let s1 = i1.stability.as_ref().map(|s| s.level);
2403 let s2 = i2.stability.as_ref().map(|s| s.level);
2405 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
2406 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
2409 let lhs = i1.name.as_ref().map_or("", |s| &**s);
2410 let rhs = i2.name.as_ref().map_or("", |s| &**s);
2411 name_key(lhs).cmp(&name_key(rhs))
2414 if cx.shared.sort_modules_alphabetically {
2415 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
2417 // This call is to remove re-export duplicates in cases such as:
2422 // pub trait Double { fn foo(); }
2426 // pub use foo::bar::*;
2430 // `Double` will appear twice in the generated docs.
2432 // FIXME: This code is quite ugly and could be improved. Small issue: DefId
2433 // can be identical even if the elements are different (mostly in imports).
2434 // So in case this is an import, we keep everything by adding a "unique id"
2435 // (which is the position in the vector).
2436 indices.dedup_by_key(|i| (items[*i].def_id,
2437 if items[*i].name.as_ref().is_some() {
2438 Some(full_path(cx, &items[*i]).clone())
2443 if items[*i].is_import() {
2449 debug!("{:?}", indices);
2450 let mut curty = None;
2451 for &idx in &indices {
2452 let myitem = &items[idx];
2453 if myitem.is_stripped() {
2457 let myty = Some(myitem.type_());
2458 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
2459 // Put `extern crate` and `use` re-exports in the same section.
2461 } else if myty != curty {
2462 if curty.is_some() {
2463 write!(w, "</table>")?;
2466 let (short, name) = item_ty_to_strs(&myty.unwrap());
2467 write!(w, "<h2 id='{id}' class='section-header'>\
2468 <a href=\"#{id}\">{name}</a></h2>\n<table>",
2469 id = cx.derive_id(short.to_owned()), name = name)?;
2472 match myitem.inner {
2473 clean::ExternCrateItem(ref name, ref src) => {
2474 use html::format::HRef;
2478 write!(w, "<tr><td><code>{}extern crate {} as {};",
2479 VisSpace(&myitem.visibility),
2480 HRef::new(myitem.def_id, src),
2484 write!(w, "<tr><td><code>{}extern crate {};",
2485 VisSpace(&myitem.visibility),
2486 HRef::new(myitem.def_id, name))?
2489 write!(w, "</code></td></tr>")?;
2492 clean::ImportItem(ref import) => {
2493 write!(w, "<tr><td><code>{}{}</code></td></tr>",
2494 VisSpace(&myitem.visibility), *import)?;
2498 if myitem.name.is_none() { continue }
2500 let stabilities = short_stability(myitem, cx, false);
2502 let stab_docs = if !stabilities.is_empty() {
2504 .map(|s| format!("[{}]", s))
2505 .collect::<Vec<_>>()
2512 let unsafety_flag = match myitem.inner {
2513 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
2514 if func.header.unsafety == hir::Unsafety::Unsafe => {
2515 "<a title='unsafe function' href='#'><sup>âš </sup></a>"
2520 let doc_value = myitem.doc_value().unwrap_or("");
2522 <tr class='{stab} module-item'>
2523 <td><a class=\"{class}\" href=\"{href}\"
2524 title='{title_type} {title}'>{name}</a>{unsafety_flag}</td>
2525 <td class='docblock-short'>
2529 name = *myitem.name.as_ref().unwrap(),
2530 stab_docs = stab_docs,
2531 docs = MarkdownSummaryLine(doc_value, &myitem.links()),
2532 class = myitem.type_(),
2533 stab = myitem.stability_class().unwrap_or(String::new()),
2534 unsafety_flag = unsafety_flag,
2535 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
2536 title_type = myitem.type_(),
2537 title = full_path(cx, myitem))?;
2542 if curty.is_some() {
2543 write!(w, "</table>")?;
2548 fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
2549 let mut stability = vec![];
2550 let error_codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
2552 if let Some(stab) = item.stability.as_ref() {
2553 let deprecated_reason = if show_reason && !stab.deprecated_reason.is_empty() {
2554 format!(": {}", stab.deprecated_reason)
2558 if !stab.deprecated_since.is_empty() {
2559 let since = if show_reason {
2560 format!(" since {}", Escape(&stab.deprecated_since))
2564 let mut ids = cx.id_map.borrow_mut();
2565 let html = MarkdownHtml(&deprecated_reason, RefCell::new(&mut ids), error_codes);
2566 let text = if stability::deprecation_in_effect(&stab.deprecated_since) {
2567 format!("Deprecated{}{}", since, html)
2569 format!("Deprecating in {}{}", Escape(&stab.deprecated_since), html)
2571 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
2574 if stab.level == stability::Unstable {
2576 let unstable_extra = match (!stab.feature.is_empty(),
2577 &cx.shared.issue_tracker_base_url,
2579 (true, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
2580 format!(" (<code>{} </code><a href=\"{}{}\">#{}</a>)",
2581 Escape(&stab.feature), tracker_url, issue_no, issue_no),
2582 (false, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
2583 format!(" (<a href=\"{}{}\">#{}</a>)", Escape(&tracker_url), issue_no,
2586 format!(" (<code>{}</code>)", Escape(&stab.feature)),
2589 if stab.unstable_reason.is_empty() {
2590 stability.push(format!("<div class='stab unstable'>\
2591 <span class=microscope>🔬</span> \
2592 This is a nightly-only experimental API. {}\
2596 let mut ids = cx.id_map.borrow_mut();
2597 let text = format!("<summary><span class=microscope>🔬</span> \
2598 This is a nightly-only experimental API. {}\
2602 &stab.unstable_reason,
2603 RefCell::new(&mut ids),
2605 stability.push(format!("<div class='stab unstable'><details>{}</details></div>",
2609 stability.push("<div class='stab unstable'>Experimental</div>".to_string())
2612 } else if let Some(depr) = item.deprecation.as_ref() {
2613 let note = if show_reason && !depr.note.is_empty() {
2614 format!(": {}", depr.note)
2618 let since = if show_reason && !depr.since.is_empty() {
2619 format!(" since {}", Escape(&depr.since))
2624 let mut ids = cx.id_map.borrow_mut();
2625 let text = if stability::deprecation_in_effect(&depr.since) {
2626 format!("Deprecated{}{}",
2628 MarkdownHtml(¬e, RefCell::new(&mut ids), error_codes))
2630 format!("Deprecating in {}{}",
2631 Escape(&depr.since),
2632 MarkdownHtml(¬e, RefCell::new(&mut ids), error_codes))
2634 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
2637 if let Some(ref cfg) = item.attrs.cfg {
2638 stability.push(format!("<div class='stab portability'>{}</div>", if show_reason {
2639 cfg.render_long_html()
2641 cfg.render_short_html()
2648 fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2649 c: &clean::Constant) -> fmt::Result {
2650 write!(w, "<pre class='rust const'>")?;
2651 render_attributes(w, it)?;
2652 write!(w, "{vis}const \
2653 {name}: {typ}</pre>",
2654 vis = VisSpace(&it.visibility),
2655 name = it.name.as_ref().unwrap(),
2660 fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2661 s: &clean::Static) -> fmt::Result {
2662 write!(w, "<pre class='rust static'>")?;
2663 render_attributes(w, it)?;
2664 write!(w, "{vis}static {mutability}\
2665 {name}: {typ}</pre>",
2666 vis = VisSpace(&it.visibility),
2667 mutability = MutableSpace(s.mutability),
2668 name = it.name.as_ref().unwrap(),
2673 fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2674 f: &clean::Function) -> fmt::Result {
2675 let name_len = format!("{}{}{}{}{:#}fn {}{:#}",
2676 VisSpace(&it.visibility),
2677 ConstnessSpace(f.header.constness),
2678 UnsafetySpace(f.header.unsafety),
2679 AsyncSpace(f.header.asyncness),
2680 AbiSpace(f.header.abi),
2681 it.name.as_ref().unwrap(),
2683 write!(w, "{}<pre class='rust fn'>", render_spotlight_traits(it)?)?;
2684 render_attributes(w, it)?;
2686 "{vis}{constness}{unsafety}{asyncness}{abi}fn \
2687 {name}{generics}{decl}{where_clause}</pre>",
2688 vis = VisSpace(&it.visibility),
2689 constness = ConstnessSpace(f.header.constness),
2690 unsafety = UnsafetySpace(f.header.unsafety),
2691 asyncness = AsyncSpace(f.header.asyncness),
2692 abi = AbiSpace(f.header.abi),
2693 name = it.name.as_ref().unwrap(),
2694 generics = f.generics,
2695 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2704 fn render_implementor(cx: &Context, implementor: &Impl, w: &mut fmt::Formatter,
2705 implementor_dups: &FxHashMap<&str, (DefId, bool)>) -> fmt::Result {
2706 // If there's already another implementor that has the same abbridged name, use the
2707 // full path, for example in `std::iter::ExactSizeIterator`
2708 let use_absolute = match implementor.inner_impl().for_ {
2709 clean::ResolvedPath { ref path, is_generic: false, .. } |
2710 clean::BorrowedRef {
2711 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2713 } => implementor_dups[path.last_name()].1,
2716 render_impl(w, cx, implementor, AssocItemLink::Anchor(None), RenderMode::Normal,
2717 implementor.impl_item.stable_since(), false, Some(use_absolute))?;
2721 fn render_impls(cx: &Context, w: &mut fmt::Formatter,
2723 containing_item: &clean::Item) -> fmt::Result {
2725 let did = i.trait_did().unwrap();
2726 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2727 render_impl(w, cx, i, assoc_link,
2728 RenderMode::Normal, containing_item.stable_since(), true, None)?;
2733 fn bounds(t_bounds: &[clean::GenericBound]) -> String {
2734 let mut bounds = String::new();
2735 let mut bounds_plain = String::new();
2736 if !t_bounds.is_empty() {
2737 if !bounds.is_empty() {
2739 bounds_plain.push(' ');
2741 bounds.push_str(": ");
2742 bounds_plain.push_str(": ");
2743 for (i, p) in t_bounds.iter().enumerate() {
2745 bounds.push_str(" + ");
2746 bounds_plain.push_str(" + ");
2748 bounds.push_str(&(*p).to_string());
2749 bounds_plain.push_str(&format!("{:#}", *p));
2755 fn compare_impl<'a, 'b>(lhs: &'a &&Impl, rhs: &'b &&Impl) -> Ordering {
2756 let lhs = format!("{}", lhs.inner_impl());
2757 let rhs = format!("{}", rhs.inner_impl());
2759 // lhs and rhs are formatted as HTML, which may be unnecessary
2760 name_key(&lhs).cmp(&name_key(&rhs))
2764 w: &mut fmt::Formatter,
2769 let bounds = bounds(&t.bounds);
2770 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2771 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2772 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2773 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2775 // Output the trait definition
2776 wrap_into_docblock(w, |w| {
2777 write!(w, "<pre class='rust trait'>")?;
2778 render_attributes(w, it)?;
2779 write!(w, "{}{}{}trait {}{}{}",
2780 VisSpace(&it.visibility),
2781 UnsafetySpace(t.unsafety),
2782 if t.is_auto { "auto " } else { "" },
2783 it.name.as_ref().unwrap(),
2787 if !t.generics.where_predicates.is_empty() {
2788 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true })?;
2793 if t.items.is_empty() {
2794 write!(w, "{{ }}")?;
2796 // FIXME: we should be using a derived_id for the Anchors here
2800 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2803 if !types.is_empty() && !consts.is_empty() {
2808 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2811 if !consts.is_empty() && !required.is_empty() {
2814 for (pos, m) in required.iter().enumerate() {
2816 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2819 if pos < required.len() - 1 {
2820 write!(w, "<div class='item-spacer'></div>")?;
2823 if !required.is_empty() && !provided.is_empty() {
2826 for (pos, m) in provided.iter().enumerate() {
2828 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2830 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2831 write!(w, ",\n {{ ... }}\n")?;
2834 write!(w, " {{ ... }}\n")?;
2837 if pos < provided.len() - 1 {
2838 write!(w, "<div class='item-spacer'></div>")?;
2846 // Trait documentation
2847 document(w, cx, it)?;
2849 fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item, t: &clean::Item)
2851 let name = m.name.as_ref().unwrap();
2852 let item_type = m.type_();
2853 let id = cx.derive_id(format!("{}.{}", item_type, name));
2854 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
2855 write!(w, "{extra}<h3 id='{id}' class='method'>\
2856 <span id='{ns_id}' class='invisible'><code>",
2857 extra = render_spotlight_traits(m)?,
2860 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl)?;
2861 write!(w, "</code>")?;
2862 render_stability_since(w, m, t)?;
2863 write!(w, "</span></h3>")?;
2864 document(w, cx, m)?;
2868 if !types.is_empty() {
2870 <h2 id='associated-types' class='small-section-header'>
2871 Associated Types<a href='#associated-types' class='anchor'></a>
2873 <div class='methods'>
2876 trait_item(w, cx, *t, it)?;
2878 write!(w, "</div>")?;
2881 if !consts.is_empty() {
2883 <h2 id='associated-const' class='small-section-header'>
2884 Associated Constants<a href='#associated-const' class='anchor'></a>
2886 <div class='methods'>
2889 trait_item(w, cx, *t, it)?;
2891 write!(w, "</div>")?;
2894 // Output the documentation for each function individually
2895 if !required.is_empty() {
2897 <h2 id='required-methods' class='small-section-header'>
2898 Required Methods<a href='#required-methods' class='anchor'></a>
2900 <div class='methods'>
2902 for m in &required {
2903 trait_item(w, cx, *m, it)?;
2905 write!(w, "</div>")?;
2907 if !provided.is_empty() {
2909 <h2 id='provided-methods' class='small-section-header'>
2910 Provided Methods<a href='#provided-methods' class='anchor'></a>
2912 <div class='methods'>
2914 for m in &provided {
2915 trait_item(w, cx, *m, it)?;
2917 write!(w, "</div>")?;
2920 // If there are methods directly on this trait object, render them here.
2921 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
2923 let cache = cache();
2924 let impl_header = "\
2925 <h2 id='implementors' class='small-section-header'>\
2926 Implementors<a href='#implementors' class='anchor'></a>\
2928 <div class='item-list' id='implementors-list'>\
2931 let synthetic_impl_header = "\
2932 <h2 id='synthetic-implementors' class='small-section-header'>\
2933 Auto implementors<a href='#synthetic-implementors' class='anchor'></a>\
2935 <div class='item-list' id='synthetic-implementors-list'>\
2938 let mut synthetic_types = Vec::new();
2940 if let Some(implementors) = cache.implementors.get(&it.def_id) {
2941 // The DefId is for the first Type found with that name. The bool is
2942 // if any Types with the same name but different DefId have been found.
2943 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap();
2944 for implementor in implementors {
2945 match implementor.inner_impl().for_ {
2946 clean::ResolvedPath { ref path, did, is_generic: false, .. } |
2947 clean::BorrowedRef {
2948 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
2951 let &mut (prev_did, ref mut has_duplicates) =
2952 implementor_dups.entry(path.last_name()).or_insert((did, false));
2953 if prev_did != did {
2954 *has_duplicates = true;
2961 let (local, foreign) = implementors.iter()
2962 .partition::<Vec<_>, _>(|i| i.inner_impl().for_.def_id()
2963 .map_or(true, |d| cache.paths.contains_key(&d)));
2966 let (mut synthetic, mut concrete): (Vec<&&Impl>, Vec<&&Impl>) = local.iter()
2967 .partition(|i| i.inner_impl().synthetic);
2969 synthetic.sort_by(compare_impl);
2970 concrete.sort_by(compare_impl);
2972 if !foreign.is_empty() {
2974 <h2 id='foreign-impls' class='small-section-header'>
2975 Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
2979 for implementor in foreign {
2980 let assoc_link = AssocItemLink::GotoSource(
2981 implementor.impl_item.def_id,
2982 &implementor.inner_impl().provided_trait_methods
2984 render_impl(w, cx, &implementor, assoc_link,
2985 RenderMode::Normal, implementor.impl_item.stable_since(), false,
2990 write!(w, "{}", impl_header)?;
2991 for implementor in concrete {
2992 render_implementor(cx, implementor, w, &implementor_dups)?;
2994 write!(w, "</div>")?;
2997 write!(w, "{}", synthetic_impl_header)?;
2998 for implementor in synthetic {
2999 synthetic_types.extend(
3000 collect_paths_for_type(implementor.inner_impl().for_.clone())
3002 render_implementor(cx, implementor, w, &implementor_dups)?;
3004 write!(w, "</div>")?;
3007 // even without any implementations to write in, we still want the heading and list, so the
3008 // implementors javascript file pulled in below has somewhere to write the impls into
3009 write!(w, "{}", impl_header)?;
3010 write!(w, "</div>")?;
3013 write!(w, "{}", synthetic_impl_header)?;
3014 write!(w, "</div>")?;
3017 write!(w, r#"<script type="text/javascript">window.inlined_types=new Set({});</script>"#,
3018 as_json(&synthetic_types))?;
3020 write!(w, r#"<script type="text/javascript" async
3021 src="{root_path}/implementors/{path}/{ty}.{name}.js">
3023 root_path = vec![".."; cx.current.len()].join("/"),
3024 path = if it.def_id.is_local() {
3025 cx.current.join("/")
3027 let (ref path, _) = cache.external_paths[&it.def_id];
3028 path[..path.len() - 1].join("/")
3030 ty = it.type_().css_class(),
3031 name = *it.name.as_ref().unwrap())?;
3035 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink) -> String {
3036 use html::item_type::ItemType::*;
3038 let name = it.name.as_ref().unwrap();
3039 let ty = match it.type_() {
3040 Typedef | AssociatedType => AssociatedType,
3044 let anchor = format!("#{}.{}", ty, name);
3046 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
3047 AssocItemLink::Anchor(None) => anchor,
3048 AssocItemLink::GotoSource(did, _) => {
3049 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
3054 fn assoc_const(w: &mut fmt::Formatter,
3057 _default: Option<&String>,
3058 link: AssocItemLink) -> fmt::Result {
3059 write!(w, "{}const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
3060 VisSpace(&it.visibility),
3061 naive_assoc_href(it, link),
3062 it.name.as_ref().unwrap(),
3067 fn assoc_type<W: fmt::Write>(w: &mut W, it: &clean::Item,
3068 bounds: &[clean::GenericBound],
3069 default: Option<&clean::Type>,
3070 link: AssocItemLink) -> fmt::Result {
3071 write!(w, "type <a href='{}' class=\"type\">{}</a>",
3072 naive_assoc_href(it, link),
3073 it.name.as_ref().unwrap())?;
3074 if !bounds.is_empty() {
3075 write!(w, ": {}", GenericBounds(bounds))?
3077 if let Some(default) = default {
3078 write!(w, " = {}", default)?;
3083 fn render_stability_since_raw<'a>(w: &mut fmt::Formatter,
3084 ver: Option<&'a str>,
3085 containing_ver: Option<&'a str>) -> fmt::Result {
3086 if let Some(v) = ver {
3087 if containing_ver != ver && v.len() > 0 {
3088 write!(w, "<div class='since' title='Stable since Rust version {0}'>{0}</div>",
3095 fn render_stability_since(w: &mut fmt::Formatter,
3097 containing_item: &clean::Item) -> fmt::Result {
3098 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
3101 fn render_assoc_item(w: &mut fmt::Formatter,
3103 link: AssocItemLink,
3104 parent: ItemType) -> fmt::Result {
3105 fn method(w: &mut fmt::Formatter,
3107 header: hir::FnHeader,
3108 g: &clean::Generics,
3110 link: AssocItemLink,
3113 let name = meth.name.as_ref().unwrap();
3114 let anchor = format!("#{}.{}", meth.type_(), name);
3115 let href = match link {
3116 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
3117 AssocItemLink::Anchor(None) => anchor,
3118 AssocItemLink::GotoSource(did, provided_methods) => {
3119 // We're creating a link from an impl-item to the corresponding
3120 // trait-item and need to map the anchored type accordingly.
3121 let ty = if provided_methods.contains(name) {
3127 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
3130 let mut head_len = format!("{}{}{}{}{:#}fn {}{:#}",
3131 VisSpace(&meth.visibility),
3132 ConstnessSpace(header.constness),
3133 UnsafetySpace(header.unsafety),
3134 AsyncSpace(header.asyncness),
3135 AbiSpace(header.abi),
3138 let (indent, end_newline) = if parent == ItemType::Trait {
3144 render_attributes(w, meth)?;
3145 write!(w, "{}{}{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
3146 {generics}{decl}{where_clause}",
3147 VisSpace(&meth.visibility),
3148 ConstnessSpace(header.constness),
3149 UnsafetySpace(header.unsafety),
3150 AsyncSpace(header.asyncness),
3151 AbiSpace(header.abi),
3160 where_clause = WhereClause {
3167 clean::StrippedItem(..) => Ok(()),
3168 clean::TyMethodItem(ref m) => {
3169 method(w, item, m.header, &m.generics, &m.decl, link, parent)
3171 clean::MethodItem(ref m) => {
3172 method(w, item, m.header, &m.generics, &m.decl, link, parent)
3174 clean::AssociatedConstItem(ref ty, ref default) => {
3175 assoc_const(w, item, ty, default.as_ref(), link)
3177 clean::AssociatedTypeItem(ref bounds, ref default) => {
3178 assoc_type(w, item, bounds, default.as_ref(), link)
3180 _ => panic!("render_assoc_item called on non-associated-item")
3184 fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3185 s: &clean::Struct) -> fmt::Result {
3186 wrap_into_docblock(w, |w| {
3187 write!(w, "<pre class='rust struct'>")?;
3188 render_attributes(w, it)?;
3199 document(w, cx, it)?;
3200 let mut fields = s.fields.iter().filter_map(|f| {
3202 clean::StructFieldItem(ref ty) => Some((f, ty)),
3206 if let doctree::Plain = s.struct_type {
3207 if fields.peek().is_some() {
3208 write!(w, "<h2 id='fields' class='fields small-section-header'>
3209 Fields{}<a href='#fields' class='anchor'></a></h2>",
3210 document_non_exhaustive_header(it))?;
3211 document_non_exhaustive(w, it)?;
3212 for (field, ty) in fields {
3213 let id = cx.derive_id(format!("{}.{}",
3214 ItemType::StructField,
3215 field.name.as_ref().unwrap()));
3216 let ns_id = cx.derive_id(format!("{}.{}",
3217 field.name.as_ref().unwrap(),
3218 ItemType::StructField.name_space()));
3219 write!(w, "<span id=\"{id}\" class=\"{item_type} small-section-header\">
3220 <a href=\"#{id}\" class=\"anchor field\"></a>
3221 <span id=\"{ns_id}\" class='invisible'>
3222 <code>{name}: {ty}</code>
3224 item_type = ItemType::StructField,
3227 name = field.name.as_ref().unwrap(),
3229 if let Some(stability_class) = field.stability_class() {
3230 write!(w, "<span class='stab {stab}'></span>",
3231 stab = stability_class)?;
3233 document(w, cx, field)?;
3237 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3240 fn item_union(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3241 s: &clean::Union) -> fmt::Result {
3242 wrap_into_docblock(w, |w| {
3243 write!(w, "<pre class='rust union'>")?;
3244 render_attributes(w, it)?;
3254 document(w, cx, it)?;
3255 let mut fields = s.fields.iter().filter_map(|f| {
3257 clean::StructFieldItem(ref ty) => Some((f, ty)),
3261 if fields.peek().is_some() {
3262 write!(w, "<h2 id='fields' class='fields small-section-header'>
3263 Fields<a href='#fields' class='anchor'></a></h2>")?;
3264 for (field, ty) in fields {
3265 let name = field.name.as_ref().expect("union field name");
3266 let id = format!("{}.{}", ItemType::StructField, name);
3267 write!(w, "<span id=\"{id}\" class=\"{shortty} small-section-header\">\
3268 <a href=\"#{id}\" class=\"anchor field\"></a>\
3269 <span class='invisible'><code>{name}: {ty}</code></span>\
3273 shortty = ItemType::StructField,
3275 if let Some(stability_class) = field.stability_class() {
3276 write!(w, "<span class='stab {stab}'></span>",
3277 stab = stability_class)?;
3279 document(w, cx, field)?;
3282 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3285 fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3286 e: &clean::Enum) -> fmt::Result {
3287 wrap_into_docblock(w, |w| {
3288 write!(w, "<pre class='rust enum'>")?;
3289 render_attributes(w, it)?;
3290 write!(w, "{}enum {}{}{}",
3291 VisSpace(&it.visibility),
3292 it.name.as_ref().unwrap(),
3294 WhereClause { gens: &e.generics, indent: 0, end_newline: true })?;
3295 if e.variants.is_empty() && !e.variants_stripped {
3296 write!(w, " {{}}")?;
3298 write!(w, " {{\n")?;
3299 for v in &e.variants {
3301 let name = v.name.as_ref().unwrap();
3303 clean::VariantItem(ref var) => {
3305 clean::VariantKind::CLike => write!(w, "{}", name)?,
3306 clean::VariantKind::Tuple(ref tys) => {
3307 write!(w, "{}(", name)?;
3308 for (i, ty) in tys.iter().enumerate() {
3310 write!(w, ", ")?
3312 write!(w, "{}", *ty)?;
3316 clean::VariantKind::Struct(ref s) => {
3332 if e.variants_stripped {
3333 write!(w, " // some variants omitted\n")?;
3340 document(w, cx, it)?;
3341 if !e.variants.is_empty() {
3342 write!(w, "<h2 id='variants' class='variants small-section-header'>
3343 Variants{}<a href='#variants' class='anchor'></a></h2>\n",
3344 document_non_exhaustive_header(it))?;
3345 document_non_exhaustive(w, it)?;
3346 for variant in &e.variants {
3347 let id = cx.derive_id(format!("{}.{}",
3349 variant.name.as_ref().unwrap()));
3350 let ns_id = cx.derive_id(format!("{}.{}",
3351 variant.name.as_ref().unwrap(),
3352 ItemType::Variant.name_space()));
3353 write!(w, "<span id=\"{id}\" class=\"variant small-section-header\">\
3354 <a href=\"#{id}\" class=\"anchor field\"></a>\
3355 <span id='{ns_id}' class='invisible'><code>{name}",
3358 name = variant.name.as_ref().unwrap())?;
3359 if let clean::VariantItem(ref var) = variant.inner {
3360 if let clean::VariantKind::Tuple(ref tys) = var.kind {
3362 for (i, ty) in tys.iter().enumerate() {
3364 write!(w, ", ")?;
3366 write!(w, "{}", *ty)?;
3371 write!(w, "</code></span></span>")?;
3372 document(w, cx, variant)?;
3374 use clean::{Variant, VariantKind};
3375 if let clean::VariantItem(Variant {
3376 kind: VariantKind::Struct(ref s)
3377 }) = variant.inner {
3378 let variant_id = cx.derive_id(format!("{}.{}.fields",
3380 variant.name.as_ref().unwrap()));
3381 write!(w, "<span class='docblock autohide sub-variant' id='{id}'>",
3383 write!(w, "<h3 class='fields'>Fields of <code>{name}</code></h3>\n
3384 <table>", name = variant.name.as_ref().unwrap())?;
3385 for field in &s.fields {
3386 use clean::StructFieldItem;
3387 if let StructFieldItem(ref ty) = field.inner {
3388 let id = cx.derive_id(format!("variant.{}.field.{}",
3389 variant.name.as_ref().unwrap(),
3390 field.name.as_ref().unwrap()));
3391 let ns_id = cx.derive_id(format!("{}.{}.{}.{}",
3392 variant.name.as_ref().unwrap(),
3393 ItemType::Variant.name_space(),
3394 field.name.as_ref().unwrap(),
3395 ItemType::StructField.name_space()));
3396 write!(w, "<tr><td \
3398 <span id='{ns_id}' class='invisible'>\
3399 <code>{f}: {t}</code></span></td><td>",
3402 f = field.name.as_ref().unwrap(),
3404 document(w, cx, field)?;
3405 write!(w, "</td></tr>")?;
3408 write!(w, "</table></span>")?;
3410 render_stability_since(w, variant, it)?;
3413 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
3417 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
3418 let name = attr.name();
3421 Some(name.to_string())
3422 } else if let Some(v) = attr.value_str() {
3423 Some(format!("{} = {:?}", name, v.as_str()))
3424 } else if let Some(values) = attr.meta_item_list() {
3425 let display: Vec<_> = values.iter().filter_map(|attr| {
3426 attr.meta_item().and_then(|mi| render_attribute(mi))
3429 if display.len() > 0 {
3430 Some(format!("{}({})", name, display.join(", ")))
3439 const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
3446 "unsafe_destructor_blind_to_params",
3450 fn render_attributes(w: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
3451 let mut attrs = String::new();
3453 for attr in &it.attrs.other_attrs {
3454 let name = attr.name();
3455 if !ATTRIBUTE_WHITELIST.contains(&&*name.as_str()) {
3458 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
3459 attrs.push_str(&format!("#[{}]\n", s));
3462 if attrs.len() > 0 {
3463 write!(w, "<div class=\"docblock attributes\">{}</div>", &attrs)?;
3468 fn render_struct(w: &mut fmt::Formatter, it: &clean::Item,
3469 g: Option<&clean::Generics>,
3470 ty: doctree::StructType,
3471 fields: &[clean::Item],
3473 structhead: bool) -> fmt::Result {
3475 VisSpace(&it.visibility),
3476 if structhead {"struct "} else {""},
3477 it.name.as_ref().unwrap())?;
3478 if let Some(g) = g {
3483 if let Some(g) = g {
3484 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?
3486 let mut has_visible_fields = false;
3488 for field in fields {
3489 if let clean::StructFieldItem(ref ty) = field.inner {
3490 write!(w, "\n{} {}{}: {},",
3492 VisSpace(&field.visibility),
3493 field.name.as_ref().unwrap(),
3495 has_visible_fields = true;
3499 if has_visible_fields {
3500 if it.has_stripped_fields().unwrap() {
3501 write!(w, "\n{} // some fields omitted", tab)?;
3503 write!(w, "\n{}", tab)?;
3504 } else if it.has_stripped_fields().unwrap() {
3505 // If there are no visible fields we can just display
3506 // `{ /* fields omitted */ }` to save space.
3507 write!(w, " /* fields omitted */ ")?;
3513 for (i, field) in fields.iter().enumerate() {
3518 clean::StrippedItem(box clean::StructFieldItem(..)) => {
3521 clean::StructFieldItem(ref ty) => {
3522 write!(w, "{}{}", VisSpace(&field.visibility), *ty)?
3528 if let Some(g) = g {
3529 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
3534 // Needed for PhantomData.
3535 if let Some(g) = g {
3536 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
3544 fn render_union(w: &mut fmt::Formatter, it: &clean::Item,
3545 g: Option<&clean::Generics>,
3546 fields: &[clean::Item],
3548 structhead: bool) -> fmt::Result {
3550 VisSpace(&it.visibility),
3551 if structhead {"union "} else {""},
3552 it.name.as_ref().unwrap())?;
3553 if let Some(g) = g {
3554 write!(w, "{}", g)?;
3555 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?;
3558 write!(w, " {{\n{}", tab)?;
3559 for field in fields {
3560 if let clean::StructFieldItem(ref ty) = field.inner {
3561 write!(w, " {}{}: {},\n{}",
3562 VisSpace(&field.visibility),
3563 field.name.as_ref().unwrap(),
3569 if it.has_stripped_fields().unwrap() {
3570 write!(w, " // some fields omitted\n{}", tab)?;
3576 #[derive(Copy, Clone)]
3577 enum AssocItemLink<'a> {
3578 Anchor(Option<&'a str>),
3579 GotoSource(DefId, &'a FxHashSet<String>),
3582 impl<'a> AssocItemLink<'a> {
3583 fn anchor(&self, id: &'a String) -> Self {
3585 AssocItemLink::Anchor(_) => { AssocItemLink::Anchor(Some(&id)) },
3586 ref other => *other,
3591 enum AssocItemRender<'a> {
3593 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool }
3596 #[derive(Copy, Clone, PartialEq)]
3599 ForDeref { mut_: bool },
3602 fn render_assoc_items(w: &mut fmt::Formatter,
3604 containing_item: &clean::Item,
3606 what: AssocItemRender) -> fmt::Result {
3608 let v = match c.impls.get(&it) {
3610 None => return Ok(()),
3612 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| {
3613 i.inner_impl().trait_.is_none()
3615 if !non_trait.is_empty() {
3616 let render_mode = match what {
3617 AssocItemRender::All => {
3619 <h2 id='methods' class='small-section-header'>\
3620 Methods<a href='#methods' class='anchor'></a>\
3625 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
3627 <h2 id='deref-methods' class='small-section-header'>\
3628 Methods from {}<Target = {}>\
3629 <a href='#deref-methods' class='anchor'></a>\
3632 RenderMode::ForDeref { mut_: deref_mut_ }
3635 for i in &non_trait {
3636 render_impl(w, cx, i, AssocItemLink::Anchor(None), render_mode,
3637 containing_item.stable_since(), true, None)?;
3640 if let AssocItemRender::DerefFor { .. } = what {
3643 if !traits.is_empty() {
3644 let deref_impl = traits.iter().find(|t| {
3645 t.inner_impl().trait_.def_id() == c.deref_trait_did
3647 if let Some(impl_) = deref_impl {
3648 let has_deref_mut = traits.iter().find(|t| {
3649 t.inner_impl().trait_.def_id() == c.deref_mut_trait_did
3651 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut)?;
3654 let (synthetic, concrete): (Vec<&&Impl>, Vec<&&Impl>) = traits
3656 .partition(|t| t.inner_impl().synthetic);
3657 let (blanket_impl, concrete) = concrete
3659 .partition(|t| t.inner_impl().blanket_impl.is_some());
3661 struct RendererStruct<'a, 'b, 'c>(&'a Context, Vec<&'b &'b Impl>, &'c clean::Item);
3663 impl<'a, 'b, 'c> fmt::Display for RendererStruct<'a, 'b, 'c> {
3664 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3665 render_impls(self.0, fmt, &self.1, self.2)
3669 let impls = RendererStruct(cx, concrete, containing_item).to_string();
3670 if !impls.is_empty() {
3672 <h2 id='implementations' class='small-section-header'>\
3673 Trait Implementations<a href='#implementations' class='anchor'></a>\
3675 <div id='implementations-list'>{}</div>", impls)?;
3678 if !synthetic.is_empty() {
3680 <h2 id='synthetic-implementations' class='small-section-header'>\
3681 Auto Trait Implementations\
3682 <a href='#synthetic-implementations' class='anchor'></a>\
3684 <div id='synthetic-implementations-list'>\
3686 render_impls(cx, w, &synthetic, containing_item)?;
3687 write!(w, "</div>")?;
3690 if !blanket_impl.is_empty() {
3692 <h2 id='blanket-implementations' class='small-section-header'>\
3693 Blanket Implementations\
3694 <a href='#blanket-implementations' class='anchor'></a>\
3696 <div id='blanket-implementations-list'>\
3698 render_impls(cx, w, &blanket_impl, containing_item)?;
3699 write!(w, "</div>")?;
3705 fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl,
3706 container_item: &clean::Item, deref_mut: bool) -> fmt::Result {
3707 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
3708 let target = impl_.inner_impl().items.iter().filter_map(|item| {
3710 clean::TypedefItem(ref t, true) => Some(&t.type_),
3713 }).next().expect("Expected associated type binding");
3714 let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target,
3715 deref_mut_: deref_mut };
3716 if let Some(did) = target.def_id() {
3717 render_assoc_items(w, cx, container_item, did, what)
3719 if let Some(prim) = target.primitive_type() {
3720 if let Some(&did) = cache().primitive_locations.get(&prim) {
3721 render_assoc_items(w, cx, container_item, did, what)?;
3728 fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
3729 let self_type_opt = match item.inner {
3730 clean::MethodItem(ref method) => method.decl.self_type(),
3731 clean::TyMethodItem(ref method) => method.decl.self_type(),
3735 if let Some(self_ty) = self_type_opt {
3736 let (by_mut_ref, by_box, by_value) = match self_ty {
3737 SelfTy::SelfBorrowed(_, mutability) |
3738 SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
3739 (mutability == Mutability::Mutable, false, false)
3741 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
3742 (false, Some(did) == cache().owned_box_did, false)
3744 SelfTy::SelfValue => (false, false, true),
3745 _ => (false, false, false),
3748 (deref_mut_ || !by_mut_ref) && !by_box && !by_value
3754 fn render_spotlight_traits(item: &clean::Item) -> Result<String, fmt::Error> {
3755 let mut out = String::new();
3758 clean::FunctionItem(clean::Function { ref decl, .. }) |
3759 clean::TyMethodItem(clean::TyMethod { ref decl, .. }) |
3760 clean::MethodItem(clean::Method { ref decl, .. }) |
3761 clean::ForeignFunctionItem(clean::Function { ref decl, .. }) => {
3762 out = spotlight_decl(decl)?;
3770 fn spotlight_decl(decl: &clean::FnDecl) -> Result<String, fmt::Error> {
3771 let mut out = String::new();
3772 let mut trait_ = String::new();
3774 if let Some(did) = decl.output.def_id() {
3776 if let Some(impls) = c.impls.get(&did) {
3778 let impl_ = i.inner_impl();
3779 if impl_.trait_.def_id().map_or(false, |d| c.traits[&d].is_spotlight) {
3782 &format!("<h3 class=\"important\">Important traits for {}</h3>\
3783 <code class=\"content\">",
3785 trait_.push_str(&impl_.for_.to_string());
3788 //use the "where" class here to make it small
3789 out.push_str(&format!("<span class=\"where fmt-newline\">{}</span>", impl_));
3790 let t_did = impl_.trait_.def_id().unwrap();
3791 for it in &impl_.items {
3792 if let clean::TypedefItem(ref tydef, _) = it.inner {
3793 out.push_str("<span class=\"where fmt-newline\"> ");
3794 assoc_type(&mut out, it, &[],
3796 AssocItemLink::GotoSource(t_did, &FxHashSet()))?;
3797 out.push_str(";</span>");
3805 if !out.is_empty() {
3806 out.insert_str(0, &format!("<div class=\"important-traits\"><div class='tooltip'>ⓘ\
3807 <span class='tooltiptext'>Important traits for {}</span></div>\
3808 <div class=\"content hidden\">",
3810 out.push_str("</code></div></div>");
3816 fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink,
3817 render_mode: RenderMode, outer_version: Option<&str>,
3818 show_def_docs: bool, use_absolute: Option<bool>) -> fmt::Result {
3819 if render_mode == RenderMode::Normal {
3820 let id = cx.derive_id(match i.inner_impl().trait_ {
3821 Some(ref t) => format!("impl-{}", small_url_encode(&format!("{:#}", t))),
3822 None => "impl".to_string(),
3824 if let Some(use_absolute) = use_absolute {
3825 write!(w, "<h3 id='{}' class='impl'><span class='in-band'><table class='table-display'>\
3826 <tbody><tr><td><code>", id)?;
3827 fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute)?;
3829 for it in &i.inner_impl().items {
3830 if let clean::TypedefItem(ref tydef, _) = it.inner {
3831 write!(w, "<span class=\"where fmt-newline\"> ")?;
3832 assoc_type(w, it, &vec![], Some(&tydef.type_),
3833 AssocItemLink::Anchor(None))?;
3834 write!(w, ";</span>")?;
3838 write!(w, "</code>")?;
3840 write!(w, "<h3 id='{}' class='impl'><span class='in-band'><table class='table-display'>\
3841 <tbody><tr><td><code>{}</code>",
3842 id, i.inner_impl())?;
3844 write!(w, "<a href='#{}' class='anchor'></a>", id)?;
3845 write!(w, "</span></td><td><span class='out-of-band'>")?;
3846 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
3847 if let Some(l) = (Item { item: &i.impl_item, cx: cx }).src_href() {
3848 write!(w, "<div class='ghost'></div>")?;
3849 render_stability_since_raw(w, since, outer_version)?;
3850 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
3851 l, "goto source code")?;
3853 render_stability_since_raw(w, since, outer_version)?;
3855 write!(w, "</span></td></tr></tbody></table></h3>")?;
3856 if let Some(ref dox) = cx.shared.maybe_collapsed_doc_value(&i.impl_item) {
3857 let mut ids = cx.id_map.borrow_mut();
3858 write!(w, "<div class='docblock'>{}</div>",
3859 Markdown(&*dox, &i.impl_item.links(), RefCell::new(&mut ids), cx.codes))?;
3863 fn doc_impl_item(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
3864 link: AssocItemLink, render_mode: RenderMode,
3865 is_default_item: bool, outer_version: Option<&str>,
3866 trait_: Option<&clean::Trait>, show_def_docs: bool) -> fmt::Result {
3867 let item_type = item.type_();
3868 let name = item.name.as_ref().unwrap();
3870 let render_method_item: bool = match render_mode {
3871 RenderMode::Normal => true,
3872 RenderMode::ForDeref { mut_: deref_mut_ } => should_render_item(&item, deref_mut_),
3876 clean::MethodItem(clean::Method { ref decl, .. }) |
3877 clean::TyMethodItem(clean::TyMethod{ ref decl, .. }) => {
3878 // Only render when the method is not static or we allow static methods
3879 if render_method_item {
3880 let id = cx.derive_id(format!("{}.{}", item_type, name));
3881 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3882 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3883 write!(w, "{}", spotlight_decl(decl)?)?;
3884 write!(w, "<span id='{}' class='invisible'>", ns_id)?;
3885 write!(w, "<table class='table-display'><tbody><tr><td><code>")?;
3886 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl)?;
3887 write!(w, "</code>")?;
3888 if let Some(l) = (Item { cx, item }).src_href() {
3889 write!(w, "</span></td><td><span class='out-of-band'>")?;
3890 write!(w, "<div class='ghost'></div>")?;
3891 render_stability_since_raw(w, item.stable_since(), outer_version)?;
3892 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
3893 l, "goto source code")?;
3895 write!(w, "</td><td>")?;
3896 render_stability_since_raw(w, item.stable_since(), outer_version)?;
3898 write!(w, "</td></tr></tbody></table></span></h4>")?;
3901 clean::TypedefItem(ref tydef, _) => {
3902 let id = cx.derive_id(format!("{}.{}", ItemType::AssociatedType, name));
3903 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3904 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3905 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3906 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id))?;
3907 write!(w, "</code></span></h4>\n")?;
3909 clean::AssociatedConstItem(ref ty, ref default) => {
3910 let id = cx.derive_id(format!("{}.{}", item_type, name));
3911 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3912 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3913 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3914 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id))?;
3915 let src = if let Some(l) = (Item { cx, item }).src_href() {
3916 format!("<a class='srclink' href='{}' title='{}'>[src]</a>",
3917 l, "goto source code")
3921 write!(w, "</code>{}</span></h4>\n", src)?;
3923 clean::AssociatedTypeItem(ref bounds, ref default) => {
3924 let id = cx.derive_id(format!("{}.{}", item_type, name));
3925 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3926 write!(w, "<h4 id='{}' class=\"{}\">", id, item_type)?;
3927 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
3928 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id))?;
3929 write!(w, "</code></span></h4>\n")?;
3931 clean::StrippedItem(..) => return Ok(()),
3932 _ => panic!("can't make docs for trait item with name {:?}", item.name)
3935 if render_method_item || render_mode == RenderMode::Normal {
3936 if !is_default_item {
3937 if let Some(t) = trait_ {
3938 // The trait item may have been stripped so we might not
3939 // find any documentation or stability for it.
3940 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
3941 // We need the stability of the item from the trait
3942 // because impls can't have a stability.
3943 document_stability(w, cx, it)?;
3944 if item.doc_value().is_some() {
3945 document_full(w, item, cx, "")?;
3946 } else if show_def_docs {
3947 // In case the item isn't documented,
3948 // provide short documentation from the trait.
3949 document_short(w, cx, it, link, "")?;
3953 document_stability(w, cx, item)?;
3955 document_full(w, item, cx, "")?;
3959 document_stability(w, cx, item)?;
3961 document_short(w, cx, item, link, "")?;
3968 let traits = &cache().traits;
3969 let trait_ = i.trait_did().map(|did| &traits[&did]);
3971 write!(w, "<div class='impl-items'>")?;
3972 for trait_item in &i.inner_impl().items {
3973 doc_impl_item(w, cx, trait_item, link, render_mode,
3974 false, outer_version, trait_, show_def_docs)?;
3977 fn render_default_items(w: &mut fmt::Formatter,
3981 render_mode: RenderMode,
3982 outer_version: Option<&str>,
3983 show_def_docs: bool) -> fmt::Result {
3984 for trait_item in &t.items {
3985 let n = trait_item.name.clone();
3986 if i.items.iter().find(|m| m.name == n).is_some() {
3989 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
3990 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
3992 doc_impl_item(w, cx, trait_item, assoc_link, render_mode, true,
3993 outer_version, None, show_def_docs)?;
3998 // If we've implemented a trait, then also emit documentation for all
3999 // default items which weren't overridden in the implementation block.
4000 if let Some(t) = trait_ {
4001 render_default_items(w, cx, t, &i.inner_impl(),
4002 render_mode, outer_version, show_def_docs)?;
4004 write!(w, "</div>")?;
4009 fn item_existential(
4010 w: &mut fmt::Formatter,
4013 t: &clean::Existential,
4015 write!(w, "<pre class='rust existential'>")?;
4016 render_attributes(w, it)?;
4017 write!(w, "existential type {}{}{where_clause}: {bounds};</pre>",
4018 it.name.as_ref().unwrap(),
4020 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
4021 bounds = bounds(&t.bounds))?;
4023 document(w, cx, it)?;
4025 // Render any items associated directly to this alias, as otherwise they
4026 // won't be visible anywhere in the docs. It would be nice to also show
4027 // associated items from the aliased type (see discussion in #32077), but
4028 // we need #14072 to make sense of the generics.
4029 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4032 fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
4033 t: &clean::Typedef) -> fmt::Result {
4034 write!(w, "<pre class='rust typedef'>")?;
4035 render_attributes(w, it)?;
4036 write!(w, "type {}{}{where_clause} = {type_};</pre>",
4037 it.name.as_ref().unwrap(),
4039 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
4042 document(w, cx, it)?;
4044 // Render any items associated directly to this alias, as otherwise they
4045 // won't be visible anywhere in the docs. It would be nice to also show
4046 // associated items from the aliased type (see discussion in #32077), but
4047 // we need #14072 to make sense of the generics.
4048 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4051 fn item_foreign_type(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item) -> fmt::Result {
4052 writeln!(w, "<pre class='rust foreigntype'>extern {{")?;
4053 render_attributes(w, it)?;
4056 " {}type {};\n}}</pre>",
4057 VisSpace(&it.visibility),
4058 it.name.as_ref().unwrap(),
4061 document(w, cx, it)?;
4063 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4066 impl<'a> fmt::Display for Sidebar<'a> {
4067 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
4070 let parentlen = cx.current.len() - if it.is_mod() {1} else {0};
4072 if it.is_struct() || it.is_trait() || it.is_primitive() || it.is_union()
4073 || it.is_enum() || it.is_mod() || it.is_typedef() {
4074 write!(fmt, "<p class='location'>{}{}</p>",
4076 clean::StructItem(..) => "Struct ",
4077 clean::TraitItem(..) => "Trait ",
4078 clean::PrimitiveItem(..) => "Primitive Type ",
4079 clean::UnionItem(..) => "Union ",
4080 clean::EnumItem(..) => "Enum ",
4081 clean::TypedefItem(..) => "Type Definition ",
4082 clean::ForeignTypeItem => "Foreign Type ",
4083 clean::ModuleItem(..) => if it.is_crate() {
4090 it.name.as_ref().unwrap())?;
4094 if let Some(ref version) = cache().crate_version {
4096 "<div class='block version'>\
4102 write!(fmt, "<a id='all-types' href='all.html'><p>See all {}'s items</p></a>",
4103 it.name.as_ref().expect("crates always have a name"))?;
4106 write!(fmt, "<div class=\"sidebar-elems\">")?;
4108 clean::StructItem(ref s) => sidebar_struct(fmt, it, s)?,
4109 clean::TraitItem(ref t) => sidebar_trait(fmt, it, t)?,
4110 clean::PrimitiveItem(ref p) => sidebar_primitive(fmt, it, p)?,
4111 clean::UnionItem(ref u) => sidebar_union(fmt, it, u)?,
4112 clean::EnumItem(ref e) => sidebar_enum(fmt, it, e)?,
4113 clean::TypedefItem(ref t, _) => sidebar_typedef(fmt, it, t)?,
4114 clean::ModuleItem(ref m) => sidebar_module(fmt, it, &m.items)?,
4115 clean::ForeignTypeItem => sidebar_foreign_type(fmt, it)?,
4119 // The sidebar is designed to display sibling functions, modules and
4120 // other miscellaneous information. since there are lots of sibling
4121 // items (and that causes quadratic growth in large modules),
4122 // we refactor common parts into a shared JavaScript file per module.
4123 // still, we don't move everything into JS because we want to preserve
4124 // as much HTML as possible in order to allow non-JS-enabled browsers
4125 // to navigate the documentation (though slightly inefficiently).
4127 write!(fmt, "<p class='location'>")?;
4128 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
4130 write!(fmt, "::<wbr>")?;
4132 write!(fmt, "<a href='{}index.html'>{}</a>",
4133 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
4136 write!(fmt, "</p>")?;
4138 // Sidebar refers to the enclosing module, not this module.
4139 let relpath = if it.is_mod() { "../" } else { "" };
4141 "<script>window.sidebarCurrent = {{\
4146 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
4147 ty = it.type_().css_class(),
4150 // There is no sidebar-items.js beyond the crate root path
4151 // FIXME maybe dynamic crate loading can be merged here
4153 write!(fmt, "<script defer src=\"{path}sidebar-items.js\"></script>",
4156 // Closes sidebar-elems div.
4157 write!(fmt, "</div>")?;
4163 fn get_methods(i: &clean::Impl, for_deref: bool) -> Vec<String> {
4164 i.items.iter().filter_map(|item| {
4166 // Maybe check with clean::Visibility::Public as well?
4167 Some(ref name) if !name.is_empty() && item.visibility.is_some() && item.is_method() => {
4168 if !for_deref || should_render_item(item, false) {
4169 Some(format!("<a href=\"#method.{name}\">{name}</a>", name = name))
4176 }).collect::<Vec<_>>()
4179 // The point is to url encode any potential character from a type with genericity.
4180 fn small_url_encode(s: &str) -> String {
4181 s.replace("<", "%3C")
4182 .replace(">", "%3E")
4183 .replace(" ", "%20")
4184 .replace("?", "%3F")
4185 .replace("'", "%27")
4186 .replace("&", "%26")
4187 .replace(",", "%2C")
4188 .replace(":", "%3A")
4189 .replace(";", "%3B")
4190 .replace("[", "%5B")
4191 .replace("]", "%5D")
4192 .replace("\"", "%22")
4195 fn sidebar_assoc_items(it: &clean::Item) -> String {
4196 let mut out = String::new();
4198 if let Some(v) = c.impls.get(&it.def_id) {
4200 .filter(|i| i.inner_impl().trait_.is_none())
4201 .flat_map(|i| get_methods(i.inner_impl(), false))
4202 .collect::<String>();
4203 if !ret.is_empty() {
4204 out.push_str(&format!("<a class=\"sidebar-title\" href=\"#methods\">Methods\
4205 </a><div class=\"sidebar-links\">{}</div>", ret));
4208 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
4209 if let Some(impl_) = v.iter()
4210 .filter(|i| i.inner_impl().trait_.is_some())
4211 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did) {
4212 if let Some(target) = impl_.inner_impl().items.iter().filter_map(|item| {
4214 clean::TypedefItem(ref t, true) => Some(&t.type_),
4218 let inner_impl = target.def_id().or(target.primitive_type().and_then(|prim| {
4219 c.primitive_locations.get(&prim).cloned()
4220 })).and_then(|did| c.impls.get(&did));
4221 if let Some(impls) = inner_impl {
4222 out.push_str("<a class=\"sidebar-title\" href=\"#deref-methods\">");
4223 out.push_str(&format!("Methods from {}<Target={}>",
4224 Escape(&format!("{:#}",
4225 impl_.inner_impl().trait_.as_ref().unwrap())),
4226 Escape(&format!("{:#}", target))));
4227 out.push_str("</a>");
4228 let ret = impls.iter()
4229 .filter(|i| i.inner_impl().trait_.is_none())
4230 .flat_map(|i| get_methods(i.inner_impl(), true))
4231 .collect::<String>();
4232 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", ret));
4236 let format_impls = |impls: Vec<&Impl>| {
4237 let mut links = FxHashSet::default();
4240 let is_negative_impl = is_negative_impl(i.inner_impl());
4241 if let Some(ref i) = i.inner_impl().trait_ {
4242 let i_display = format!("{:#}", i);
4243 let out = Escape(&i_display);
4244 let encoded = small_url_encode(&format!("{:#}", i));
4245 let generated = format!("<a href=\"#impl-{}\">{}{}</a>",
4247 if is_negative_impl { "!" } else { "" },
4249 if links.insert(generated.clone()) {
4258 .collect::<String>()
4261 let (synthetic, concrete): (Vec<&Impl>, Vec<&Impl>) = v
4263 .partition::<Vec<_>, _>(|i| i.inner_impl().synthetic);
4264 let (blanket_impl, concrete): (Vec<&Impl>, Vec<&Impl>) = concrete
4266 .partition::<Vec<_>, _>(|i| i.inner_impl().blanket_impl.is_some());
4268 let concrete_format = format_impls(concrete);
4269 let synthetic_format = format_impls(synthetic);
4270 let blanket_format = format_impls(blanket_impl);
4272 if !concrete_format.is_empty() {
4273 out.push_str("<a class=\"sidebar-title\" href=\"#implementations\">\
4274 Trait Implementations</a>");
4275 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", concrete_format));
4278 if !synthetic_format.is_empty() {
4279 out.push_str("<a class=\"sidebar-title\" href=\"#synthetic-implementations\">\
4280 Auto Trait Implementations</a>");
4281 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", synthetic_format));
4284 if !blanket_format.is_empty() {
4285 out.push_str("<a class=\"sidebar-title\" href=\"#blanket-implementations\">\
4286 Blanket Implementations</a>");
4287 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", blanket_format));
4295 fn sidebar_struct(fmt: &mut fmt::Formatter, it: &clean::Item,
4296 s: &clean::Struct) -> fmt::Result {
4297 let mut sidebar = String::new();
4298 let fields = get_struct_fields_name(&s.fields);
4300 if !fields.is_empty() {
4301 if let doctree::Plain = s.struct_type {
4302 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4303 <div class=\"sidebar-links\">{}</div>", fields));
4307 sidebar.push_str(&sidebar_assoc_items(it));
4309 if !sidebar.is_empty() {
4310 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4315 fn extract_for_impl_name(item: &clean::Item) -> Option<(String, String)> {
4317 clean::ItemEnum::ImplItem(ref i) => {
4318 if let Some(ref trait_) = i.trait_ {
4319 Some((format!("{:#}", i.for_), format!("{:#}", trait_)))
4328 fn is_negative_impl(i: &clean::Impl) -> bool {
4329 i.polarity == Some(clean::ImplPolarity::Negative)
4332 fn sidebar_trait(fmt: &mut fmt::Formatter, it: &clean::Item,
4333 t: &clean::Trait) -> fmt::Result {
4334 let mut sidebar = String::new();
4340 Some(ref name) if m.is_associated_type() => {
4341 Some(format!("<a href=\"#associatedtype.{name}\">{name}</a>",
4347 .collect::<String>();
4348 let consts = t.items
4352 Some(ref name) if m.is_associated_const() => {
4353 Some(format!("<a href=\"#associatedconstant.{name}\">{name}</a>",
4359 .collect::<String>();
4360 let required = t.items
4364 Some(ref name) if m.is_ty_method() => {
4365 Some(format!("<a href=\"#tymethod.{name}\">{name}</a>",
4371 .collect::<String>();
4372 let provided = t.items
4376 Some(ref name) if m.is_method() => {
4377 Some(format!("<a href=\"#method.{name}\">{name}</a>", name=name))
4382 .collect::<String>();
4384 if !types.is_empty() {
4385 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#associated-types\">\
4386 Associated Types</a><div class=\"sidebar-links\">{}</div>",
4389 if !consts.is_empty() {
4390 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#associated-const\">\
4391 Associated Constants</a><div class=\"sidebar-links\">{}</div>",
4394 if !required.is_empty() {
4395 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#required-methods\">\
4396 Required Methods</a><div class=\"sidebar-links\">{}</div>",
4399 if !provided.is_empty() {
4400 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#provided-methods\">\
4401 Provided Methods</a><div class=\"sidebar-links\">{}</div>",
4407 if let Some(implementors) = c.implementors.get(&it.def_id) {
4408 let res = implementors.iter()
4409 .filter(|i| i.inner_impl().for_.def_id()
4410 .map_or(false, |d| !c.paths.contains_key(&d)))
4412 match extract_for_impl_name(&i.impl_item) {
4413 Some((ref name, ref url)) => {
4414 Some(format!("<a href=\"#impl-{}\">{}</a>",
4415 small_url_encode(url),
4421 .collect::<String>();
4422 if !res.is_empty() {
4423 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#foreign-impls\">\
4424 Implementations on Foreign Types</a><div \
4425 class=\"sidebar-links\">{}</div>",
4430 sidebar.push_str("<a class=\"sidebar-title\" href=\"#implementors\">Implementors</a>");
4432 sidebar.push_str("<a class=\"sidebar-title\" \
4433 href=\"#synthetic-implementors\">Auto Implementors</a>");
4436 sidebar.push_str(&sidebar_assoc_items(it));
4438 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)
4441 fn sidebar_primitive(fmt: &mut fmt::Formatter, it: &clean::Item,
4442 _p: &clean::PrimitiveType) -> fmt::Result {
4443 let sidebar = sidebar_assoc_items(it);
4445 if !sidebar.is_empty() {
4446 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4451 fn sidebar_typedef(fmt: &mut fmt::Formatter, it: &clean::Item,
4452 _t: &clean::Typedef) -> fmt::Result {
4453 let sidebar = sidebar_assoc_items(it);
4455 if !sidebar.is_empty() {
4456 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4461 fn get_struct_fields_name(fields: &[clean::Item]) -> String {
4463 .filter(|f| if let clean::StructFieldItem(..) = f.inner {
4468 .filter_map(|f| match f.name {
4469 Some(ref name) => Some(format!("<a href=\"#structfield.{name}\">\
4470 {name}</a>", name=name)),
4476 fn sidebar_union(fmt: &mut fmt::Formatter, it: &clean::Item,
4477 u: &clean::Union) -> fmt::Result {
4478 let mut sidebar = String::new();
4479 let fields = get_struct_fields_name(&u.fields);
4481 if !fields.is_empty() {
4482 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4483 <div class=\"sidebar-links\">{}</div>", fields));
4486 sidebar.push_str(&sidebar_assoc_items(it));
4488 if !sidebar.is_empty() {
4489 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4494 fn sidebar_enum(fmt: &mut fmt::Formatter, it: &clean::Item,
4495 e: &clean::Enum) -> fmt::Result {
4496 let mut sidebar = String::new();
4498 let variants = e.variants.iter()
4499 .filter_map(|v| match v.name {
4500 Some(ref name) => Some(format!("<a href=\"#variant.{name}\">{name}\
4501 </a>", name = name)),
4504 .collect::<String>();
4505 if !variants.is_empty() {
4506 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#variants\">Variants</a>\
4507 <div class=\"sidebar-links\">{}</div>", variants));
4510 sidebar.push_str(&sidebar_assoc_items(it));
4512 if !sidebar.is_empty() {
4513 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4518 fn item_ty_to_strs(ty: &ItemType) -> (&'static str, &'static str) {
4520 ItemType::ExternCrate |
4521 ItemType::Import => ("reexports", "Re-exports"),
4522 ItemType::Module => ("modules", "Modules"),
4523 ItemType::Struct => ("structs", "Structs"),
4524 ItemType::Union => ("unions", "Unions"),
4525 ItemType::Enum => ("enums", "Enums"),
4526 ItemType::Function => ("functions", "Functions"),
4527 ItemType::Typedef => ("types", "Type Definitions"),
4528 ItemType::Static => ("statics", "Statics"),
4529 ItemType::Constant => ("constants", "Constants"),
4530 ItemType::Trait => ("traits", "Traits"),
4531 ItemType::Impl => ("impls", "Implementations"),
4532 ItemType::TyMethod => ("tymethods", "Type Methods"),
4533 ItemType::Method => ("methods", "Methods"),
4534 ItemType::StructField => ("fields", "Struct Fields"),
4535 ItemType::Variant => ("variants", "Variants"),
4536 ItemType::Macro => ("macros", "Macros"),
4537 ItemType::Primitive => ("primitives", "Primitive Types"),
4538 ItemType::AssociatedType => ("associated-types", "Associated Types"),
4539 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
4540 ItemType::ForeignType => ("foreign-types", "Foreign Types"),
4541 ItemType::Keyword => ("keywords", "Keywords"),
4542 ItemType::Existential => ("existentials", "Existentials"),
4543 ItemType::ProcAttribute => ("attributes", "Attribute Macros"),
4544 ItemType::ProcDerive => ("derives", "Derive Macros"),
4548 fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
4549 items: &[clean::Item]) -> fmt::Result {
4550 let mut sidebar = String::new();
4552 if items.iter().any(|it| it.type_() == ItemType::ExternCrate ||
4553 it.type_() == ItemType::Import) {
4554 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
4556 name = "Re-exports"));
4559 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
4560 // to print its headings
4561 for &myty in &[ItemType::Primitive, ItemType::Module, ItemType::Macro, ItemType::Struct,
4562 ItemType::Enum, ItemType::Constant, ItemType::Static, ItemType::Trait,
4563 ItemType::Function, ItemType::Typedef, ItemType::Union, ItemType::Impl,
4564 ItemType::TyMethod, ItemType::Method, ItemType::StructField, ItemType::Variant,
4565 ItemType::AssociatedType, ItemType::AssociatedConst, ItemType::ForeignType] {
4566 if items.iter().any(|it| !it.is_stripped() && it.type_() == myty) {
4567 let (short, name) = item_ty_to_strs(&myty);
4568 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
4574 if !sidebar.is_empty() {
4575 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
4580 fn sidebar_foreign_type(fmt: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
4581 let sidebar = sidebar_assoc_items(it);
4582 if !sidebar.is_empty() {
4583 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4588 impl<'a> fmt::Display for Source<'a> {
4589 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
4590 let Source(s) = *self;
4591 let lines = s.lines().count();
4593 let mut tmp = lines;
4598 write!(fmt, "<pre class=\"line-numbers\">")?;
4599 for i in 1..lines + 1 {
4600 write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
4602 write!(fmt, "</pre>")?;
4604 highlight::render_with_highlighting(s, None, None, None))?;
4609 fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
4610 t: &clean::Macro) -> fmt::Result {
4611 wrap_into_docblock(w, |w| {
4612 w.write_str(&highlight::render_with_highlighting(&t.source,
4620 fn item_proc_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, m: &clean::ProcMacro)
4623 let name = it.name.as_ref().expect("proc-macros always have names");
4625 MacroKind::Bang => {
4626 write!(w, "<pre class='rust macro'>")?;
4627 write!(w, "{}!() {{ /* proc-macro */ }}", name)?;
4628 write!(w, "</pre>")?;
4630 MacroKind::Attr => {
4631 write!(w, "<pre class='rust attr'>")?;
4632 write!(w, "#[{}]", name)?;
4633 write!(w, "</pre>")?;
4635 MacroKind::Derive => {
4636 write!(w, "<pre class='rust derive'>")?;
4637 write!(w, "#[derive({})]", name)?;
4638 if !m.helpers.is_empty() {
4639 writeln!(w, "\n{{")?;
4640 writeln!(w, " // Attributes available to this derive:")?;
4641 for attr in &m.helpers {
4642 writeln!(w, " #[{}]", attr)?;
4646 write!(w, "</pre>")?;
4653 fn item_primitive(w: &mut fmt::Formatter, cx: &Context,
4655 _p: &clean::PrimitiveType) -> fmt::Result {
4656 document(w, cx, it)?;
4657 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4660 fn item_keyword(w: &mut fmt::Formatter, cx: &Context,
4662 _p: &str) -> fmt::Result {
4666 const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
4668 fn make_item_keywords(it: &clean::Item) -> String {
4669 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
4672 fn get_index_search_type(item: &clean::Item) -> Option<IndexItemFunctionType> {
4673 let decl = match item.inner {
4674 clean::FunctionItem(ref f) => &f.decl,
4675 clean::MethodItem(ref m) => &m.decl,
4676 clean::TyMethodItem(ref m) => &m.decl,
4680 let inputs = decl.inputs.values.iter().map(|arg| get_index_type(&arg.type_)).collect();
4681 let output = match decl.output {
4682 clean::FunctionRetTy::Return(ref return_type) => Some(get_index_type(return_type)),
4686 Some(IndexItemFunctionType { inputs: inputs, output: output })
4689 fn get_index_type(clean_type: &clean::Type) -> Type {
4691 name: get_index_type_name(clean_type, true).map(|s| s.to_ascii_lowercase()),
4692 generics: get_generics(clean_type),
4697 /// Returns a list of all paths used in the type.
4698 /// This is used to help deduplicate imported impls
4699 /// for reexported types. If any of the contained
4700 /// types are re-exported, we don't use the corresponding
4701 /// entry from the js file, as inlining will have already
4702 /// picked up the impl
4703 fn collect_paths_for_type(first_ty: clean::Type) -> Vec<String> {
4704 let mut out = Vec::new();
4705 let mut visited = FxHashSet();
4706 let mut work = VecDeque::new();
4707 let cache = cache();
4709 work.push_back(first_ty);
4711 while let Some(ty) = work.pop_front() {
4712 if !visited.insert(ty.clone()) {
4717 clean::Type::ResolvedPath { did, .. } => {
4718 let get_extern = || cache.external_paths.get(&did).map(|s| s.0.clone());
4719 let fqp = cache.exact_paths.get(&did).cloned().or_else(get_extern);
4723 out.push(path.join("::"));
4729 clean::Type::Tuple(tys) => {
4730 work.extend(tys.into_iter());
4732 clean::Type::Slice(ty) => {
4733 work.push_back(*ty);
4735 clean::Type::Array(ty, _) => {
4736 work.push_back(*ty);
4738 clean::Type::Unique(ty) => {
4739 work.push_back(*ty);
4741 clean::Type::RawPointer(_, ty) => {
4742 work.push_back(*ty);
4744 clean::Type::BorrowedRef { type_, .. } => {
4745 work.push_back(*type_);
4747 clean::Type::QPath { self_type, trait_, .. } => {
4748 work.push_back(*self_type);
4749 work.push_back(*trait_);
4757 fn get_index_type_name(clean_type: &clean::Type, accept_generic: bool) -> Option<String> {
4759 clean::ResolvedPath { ref path, .. } => {
4760 let segments = &path.segments;
4761 let path_segment = segments.into_iter().last().unwrap_or_else(|| panic!(
4762 "get_index_type_name(clean_type: {:?}, accept_generic: {:?}) had length zero path",
4763 clean_type, accept_generic
4765 Some(path_segment.name.clone())
4767 clean::Generic(ref s) if accept_generic => Some(s.clone()),
4768 clean::Primitive(ref p) => Some(format!("{:?}", p)),
4769 clean::BorrowedRef { ref type_, .. } => get_index_type_name(type_, accept_generic),
4770 // FIXME: add all from clean::Type.
4775 fn get_generics(clean_type: &clean::Type) -> Option<Vec<String>> {
4776 clean_type.generics()
4778 let r = types.iter()
4779 .filter_map(|t| get_index_type_name(t, false))
4780 .map(|s| s.to_ascii_lowercase())
4781 .collect::<Vec<_>>();
4790 pub fn cache() -> Arc<Cache> {
4791 CACHE_KEY.with(|c| c.borrow().clone())
4796 fn test_name_key() {
4797 assert_eq!(name_key("0"), ("", 0, 1));
4798 assert_eq!(name_key("123"), ("", 123, 0));
4799 assert_eq!(name_key("Fruit"), ("Fruit", 0, 0));
4800 assert_eq!(name_key("Fruit0"), ("Fruit", 0, 1));
4801 assert_eq!(name_key("Fruit0000"), ("Fruit", 0, 4));
4802 assert_eq!(name_key("Fruit01"), ("Fruit", 1, 1));
4803 assert_eq!(name_key("Fruit10"), ("Fruit", 10, 0));
4804 assert_eq!(name_key("Fruit123"), ("Fruit", 123, 0));
4809 fn test_name_sorting() {
4810 let names = ["Apple",
4812 "Fruit", "Fruit0", "Fruit00",
4813 "Fruit1", "Fruit01",
4814 "Fruit2", "Fruit02",
4819 let mut sorted = names.to_owned();
4820 sorted.sort_by_key(|&s| name_key(s));
4821 assert_eq!(names, sorted);