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};
56 use serialize::json::{ToJson, Json, as_json};
58 use syntax::ext::base::MacroKind;
59 use syntax::source_map::FileName;
60 use syntax::feature_gate::UnstableFeatures;
61 use rustc::hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId};
62 use rustc::middle::privacy::AccessLevels;
63 use rustc::middle::stability;
65 use rustc::util::nodemap::{FxHashMap, FxHashSet};
66 use rustc_data_structures::flock;
68 use clean::{self, AttributesExt, GetDefId, SelfTy, Mutability};
69 use config::RenderOptions;
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, static_files};
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()
206 pub error: io::Error,
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 options: RenderOptions,
494 passes: FxHashSet<String>,
495 renderinfo: RenderInfo,
496 diag: &errors::Handler) -> Result<(), Error> {
497 // need to save a copy of the options for rendering the index page
498 let md_opts = options.clone();
504 sort_modules_alphabetically,
507 extern_html_root_urls,
512 let src_root = match krate.src {
513 FileName::Real(ref p) => match p.parent() {
514 Some(p) => p.to_path_buf(),
515 None => PathBuf::new(),
519 let mut scx = SharedContext {
522 include_sources: true,
523 local_sources: Default::default(),
524 issue_tracker_base_url: None,
525 layout: layout::Layout {
527 favicon: String::new(),
529 krate: krate.name.clone(),
531 css_file_extension: extension_css,
532 created_dirs: Default::default(),
533 sort_modules_alphabetically,
538 // If user passed in `--playground-url` arg, we fill in crate name here
539 if let Some(url) = playground_url {
540 markdown::PLAYGROUND.with(|slot| {
541 *slot.borrow_mut() = Some((Some(krate.name.clone()), url));
545 // Crawl the crate attributes looking for attributes which control how we're
546 // going to emit HTML
547 if let Some(attrs) = krate.module.as_ref().map(|m| &m.attrs) {
548 for attr in attrs.lists("doc") {
549 let name = attr.name().map(|s| s.as_str());
550 match (name.as_ref().map(|s| &s[..]), attr.value_str()) {
551 (Some("html_favicon_url"), Some(s)) => {
552 scx.layout.favicon = s.to_string();
554 (Some("html_logo_url"), Some(s)) => {
555 scx.layout.logo = s.to_string();
557 (Some("html_playground_url"), Some(s)) => {
558 markdown::PLAYGROUND.with(|slot| {
559 let name = krate.name.clone();
560 *slot.borrow_mut() = Some((Some(name), s.to_string()));
563 (Some("issue_tracker_base_url"), Some(s)) => {
564 scx.issue_tracker_base_url = Some(s.to_string());
566 (Some("html_no_source"), None) if attr.is_word() => {
567 scx.include_sources = false;
574 try_err!(fs::create_dir_all(&dst), &dst);
575 krate = render_sources(&dst, &mut scx, krate)?;
579 render_redirect_pages: false,
580 codes: ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build()),
581 id_map: Rc::new(RefCell::new(id_map)),
582 shared: Arc::new(scx),
585 // Crawl the crate to build various caches used for the output
597 let external_paths = external_paths.into_iter()
598 .map(|(k, (v, t))| (k, (v, ItemType::from(t))))
601 let mut cache = Cache {
602 impls: Default::default(),
605 paths: Default::default(),
606 implementors: Default::default(),
608 parent_stack: Vec::new(),
609 search_index: Vec::new(),
610 parent_is_trait_impl: false,
611 extern_locations: Default::default(),
612 primitive_locations: Default::default(),
615 crate_version: krate.version.take(),
616 orphan_impl_items: Vec::new(),
617 orphan_trait_impls: Vec::new(),
618 traits: krate.external_traits.lock().replace(Default::default()),
622 masked_crates: mem::replace(&mut krate.masked_crates, Default::default()),
623 typarams: external_typarams,
624 aliases: Default::default(),
627 // Cache where all our extern crates are located
628 for &(n, ref e) in &krate.externs {
629 let src_root = match e.src {
630 FileName::Real(ref p) => match p.parent() {
631 Some(p) => p.to_path_buf(),
632 None => PathBuf::new(),
636 let extern_url = extern_html_root_urls.get(&e.name).map(|u| &**u);
637 cache.extern_locations.insert(n, (e.name.clone(), src_root,
638 extern_location(e, extern_url, &cx.dst)));
640 let did = DefId { krate: n, index: CRATE_DEF_INDEX };
641 cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
644 // Cache where all known primitives have their documentation located.
646 // Favor linking to as local extern as possible, so iterate all crates in
647 // reverse topological order.
648 for &(_, ref e) in krate.externs.iter().rev() {
649 for &(def_id, prim, _) in &e.primitives {
650 cache.primitive_locations.insert(prim, def_id);
653 for &(def_id, prim, _) in &krate.primitives {
654 cache.primitive_locations.insert(prim, def_id);
657 cache.stack.push(krate.name.clone());
658 krate = cache.fold_crate(krate);
660 for (trait_did, dids, impl_) in cache.orphan_trait_impls.drain(..) {
661 if cache.traits.contains_key(&trait_did) {
663 cache.impls.entry(did).or_insert(vec![]).push(impl_.clone());
668 // Build our search index
669 let index = build_index(&krate, &mut cache);
671 // Freeze the cache now that the index has been built. Put an Arc into TLS
672 // for future parallelization opportunities
673 let cache = Arc::new(cache);
674 CACHE_KEY.with(|v| *v.borrow_mut() = cache.clone());
675 CURRENT_LOCATION_KEY.with(|s| s.borrow_mut().clear());
677 write_shared(&cx, &krate, &*cache, index, &md_opts, diag)?;
679 // And finally render the whole crate's documentation
683 /// Build the search index from the collected metadata
684 fn build_index(krate: &clean::Crate, cache: &mut Cache) -> String {
685 let mut nodeid_to_pathid = FxHashMap::default();
686 let mut crate_items = Vec::with_capacity(cache.search_index.len());
687 let mut crate_paths = Vec::<Json>::new();
689 let Cache { ref mut search_index,
690 ref orphan_impl_items,
691 ref mut paths, .. } = *cache;
693 // Attach all orphan items to the type's definition if the type
694 // has since been learned.
695 for &(did, ref item) in orphan_impl_items {
696 if let Some(&(ref fqp, _)) = paths.get(&did) {
697 search_index.push(IndexItem {
699 name: item.name.clone().unwrap(),
700 path: fqp[..fqp.len() - 1].join("::"),
701 desc: plain_summary_line(item.doc_value()),
704 search_type: get_index_search_type(&item),
709 // Reduce `NodeId` in paths into smaller sequential numbers,
710 // and prune the paths that do not appear in the index.
711 let mut lastpath = String::new();
712 let mut lastpathid = 0usize;
714 for item in search_index {
715 item.parent_idx = item.parent.map(|nodeid| {
716 if nodeid_to_pathid.contains_key(&nodeid) {
717 *nodeid_to_pathid.get(&nodeid).unwrap()
719 let pathid = lastpathid;
720 nodeid_to_pathid.insert(nodeid, pathid);
723 let &(ref fqp, short) = paths.get(&nodeid).unwrap();
724 crate_paths.push(((short as usize), fqp.last().unwrap().clone()).to_json());
729 // Omit the parent path if it is same to that of the prior item.
730 if lastpath == item.path {
733 lastpath = item.path.clone();
735 crate_items.push(item.to_json());
738 let crate_doc = krate.module.as_ref().map(|module| {
739 plain_summary_line(module.doc_value())
740 }).unwrap_or(String::new());
742 let mut crate_data = BTreeMap::new();
743 crate_data.insert("doc".to_owned(), Json::String(crate_doc));
744 crate_data.insert("items".to_owned(), Json::Array(crate_items));
745 crate_data.insert("paths".to_owned(), Json::Array(crate_paths));
747 // Collect the index into a string
748 format!("searchIndex[{}] = {};",
749 as_json(&krate.name),
750 Json::Object(crate_data))
755 krate: &clean::Crate,
757 search_index: String,
758 options: &RenderOptions,
759 diag: &errors::Handler,
760 ) -> Result<(), Error> {
761 // Write out the shared files. Note that these are shared among all rustdoc
762 // docs placed in the output directory, so this needs to be a synchronized
763 // operation with respect to all other rustdocs running around.
764 let _lock = flock::Lock::panicking_new(&cx.dst.join(".lock"), true, true, true);
766 // Add all the static files. These may already exist, but we just
767 // overwrite them anyway to make sure that they're fresh and up-to-date.
769 write_minify(cx.dst.join(&format!("rustdoc{}.css", cx.shared.resource_suffix)),
770 static_files::RUSTDOC_CSS,
771 options.enable_minification)?;
772 write_minify(cx.dst.join(&format!("settings{}.css", cx.shared.resource_suffix)),
773 static_files::SETTINGS_CSS,
774 options.enable_minification)?;
776 // To avoid "light.css" to be overwritten, we'll first run over the received themes and only
777 // then we'll run over the "official" styles.
778 let mut themes: FxHashSet<String> = FxHashSet::default();
780 for entry in &cx.shared.themes {
781 let mut content = Vec::with_capacity(100000);
783 let mut f = try_err!(File::open(&entry), &entry);
784 try_err!(f.read_to_end(&mut content), &entry);
785 let theme = try_none!(try_none!(entry.file_stem(), &entry).to_str(), &entry);
786 let extension = try_none!(try_none!(entry.extension(), &entry).to_str(), &entry);
787 write(cx.dst.join(format!("{}{}.{}", theme, cx.shared.resource_suffix, extension)),
788 content.as_slice())?;
789 themes.insert(theme.to_owned());
792 write(cx.dst.join(&format!("brush{}.svg", cx.shared.resource_suffix)),
793 static_files::BRUSH_SVG)?;
794 write(cx.dst.join(&format!("wheel{}.svg", cx.shared.resource_suffix)),
795 static_files::WHEEL_SVG)?;
796 write(cx.dst.join(&format!("down-arrow{}.svg", cx.shared.resource_suffix)),
797 static_files::DOWN_ARROW_SVG)?;
798 write_minify(cx.dst.join(&format!("light{}.css", cx.shared.resource_suffix)),
799 static_files::themes::LIGHT,
800 options.enable_minification)?;
801 themes.insert("light".to_owned());
802 write_minify(cx.dst.join(&format!("dark{}.css", cx.shared.resource_suffix)),
803 static_files::themes::DARK,
804 options.enable_minification)?;
805 themes.insert("dark".to_owned());
807 let mut themes: Vec<&String> = themes.iter().collect();
809 // To avoid theme switch latencies as much as possible, we put everything theme related
810 // at the beginning of the html files into another js file.
811 write(cx.dst.join(&format!("theme{}.js", cx.shared.resource_suffix)),
813 r#"var themes = document.getElementById("theme-choices");
814 var themePicker = document.getElementById("theme-picker");
816 function switchThemeButtonState() {{
817 if (themes.style.display === "block") {{
818 themes.style.display = "none";
819 themePicker.style.borderBottomRightRadius = "3px";
820 themePicker.style.borderBottomLeftRadius = "3px";
822 themes.style.display = "block";
823 themePicker.style.borderBottomRightRadius = "0";
824 themePicker.style.borderBottomLeftRadius = "0";
828 function handleThemeButtonsBlur(e) {{
829 var active = document.activeElement;
830 var related = e.relatedTarget;
832 if (active.id !== "themePicker" &&
833 (!active.parentNode || active.parentNode.id !== "theme-choices") &&
835 (related.id !== "themePicker" &&
836 (!related.parentNode || related.parentNode.id !== "theme-choices")))) {{
837 switchThemeButtonState();
841 themePicker.onclick = switchThemeButtonState;
842 themePicker.onblur = handleThemeButtonsBlur;
843 [{}].forEach(function(item) {{
844 var but = document.createElement('button');
845 but.innerHTML = item;
846 but.onclick = function(el) {{
847 switchTheme(currentTheme, mainTheme, item);
849 but.onblur = handleThemeButtonsBlur;
850 themes.appendChild(but);
853 .map(|s| format!("\"{}\"", s))
854 .collect::<Vec<String>>()
855 .join(",")).as_bytes(),
858 write_minify(cx.dst.join(&format!("main{}.js", cx.shared.resource_suffix)),
859 static_files::MAIN_JS,
860 options.enable_minification)?;
861 write_minify(cx.dst.join(&format!("settings{}.js", cx.shared.resource_suffix)),
862 static_files::SETTINGS_JS,
863 options.enable_minification)?;
864 if cx.shared.include_sources {
865 write_minify(cx.dst.join(&format!("source-script{}.js", cx.shared.resource_suffix)),
866 static_files::sidebar::SOURCE_SCRIPT,
867 options.enable_minification)?;
871 let mut data = format!("var resourcesSuffix = \"{}\";\n",
872 cx.shared.resource_suffix);
873 data.push_str(static_files::STORAGE_JS);
874 write_minify(cx.dst.join(&format!("storage{}.js", cx.shared.resource_suffix)),
876 options.enable_minification)?;
879 if let Some(ref css) = cx.shared.css_file_extension {
880 let out = cx.dst.join(&format!("theme{}.css", cx.shared.resource_suffix));
881 if !options.enable_minification {
882 try_err!(fs::copy(css, out), css);
884 let mut f = try_err!(File::open(css), css);
885 let mut buffer = String::with_capacity(1000);
887 try_err!(f.read_to_string(&mut buffer), css);
888 write_minify(out, &buffer, options.enable_minification)?;
891 write_minify(cx.dst.join(&format!("normalize{}.css", cx.shared.resource_suffix)),
892 static_files::NORMALIZE_CSS,
893 options.enable_minification)?;
894 write(cx.dst.join("FiraSans-Regular.woff"),
895 static_files::fira_sans::REGULAR)?;
896 write(cx.dst.join("FiraSans-Medium.woff"),
897 static_files::fira_sans::MEDIUM)?;
898 write(cx.dst.join("FiraSans-LICENSE.txt"),
899 static_files::fira_sans::LICENSE)?;
900 write(cx.dst.join("Heuristica-Italic.woff"),
901 static_files::heuristica::ITALIC)?;
902 write(cx.dst.join("Heuristica-LICENSE.txt"),
903 static_files::heuristica::LICENSE)?;
904 write(cx.dst.join("SourceSerifPro-Regular.woff"),
905 static_files::source_serif_pro::REGULAR)?;
906 write(cx.dst.join("SourceSerifPro-Bold.woff"),
907 static_files::source_serif_pro::BOLD)?;
908 write(cx.dst.join("SourceSerifPro-LICENSE.txt"),
909 static_files::source_serif_pro::LICENSE)?;
910 write(cx.dst.join("SourceCodePro-Regular.woff"),
911 static_files::source_code_pro::REGULAR)?;
912 write(cx.dst.join("SourceCodePro-Semibold.woff"),
913 static_files::source_code_pro::SEMIBOLD)?;
914 write(cx.dst.join("SourceCodePro-LICENSE.txt"),
915 static_files::source_code_pro::LICENSE)?;
916 write(cx.dst.join("LICENSE-MIT.txt"),
917 static_files::LICENSE_MIT)?;
918 write(cx.dst.join("LICENSE-APACHE.txt"),
919 static_files::LICENSE_APACHE)?;
920 write(cx.dst.join("COPYRIGHT.txt"),
921 static_files::COPYRIGHT)?;
923 fn collect(path: &Path, krate: &str, key: &str) -> io::Result<(Vec<String>, Vec<String>)> {
924 let mut ret = Vec::new();
925 let mut krates = Vec::new();
927 for line in BufReader::new(File::open(path)?).lines() {
929 if !line.starts_with(key) {
932 if line.starts_with(&format!(r#"{}["{}"]"#, key, krate)) {
935 ret.push(line.to_string());
936 krates.push(line[key.len() + 2..].split('"')
938 .map(|s| s.to_owned())
939 .unwrap_or_else(|| String::new()));
945 fn show_item(item: &IndexItem, krate: &str) -> String {
946 format!("{{'crate':'{}','ty':{},'name':'{}','desc':'{}','p':'{}'{}}}",
947 krate, item.ty as usize, item.name, item.desc.replace("'", "\\'"), item.path,
948 if let Some(p) = item.parent_idx {
949 format!(",'parent':{}", p)
955 let dst = cx.dst.join("aliases.js");
957 let (mut all_aliases, _) = try_err!(collect(&dst, &krate.name, "ALIASES"), &dst);
958 let mut w = try_err!(File::create(&dst), &dst);
959 let mut output = String::with_capacity(100);
960 for (alias, items) in &cache.aliases {
961 if items.is_empty() {
964 output.push_str(&format!("\"{}\":[{}],",
967 .map(|v| show_item(v, &krate.name))
971 all_aliases.push(format!("ALIASES['{}'] = {{{}}};", krate.name, output));
973 try_err!(writeln!(&mut w, "var ALIASES = {{}};"), &dst);
974 for aliases in &all_aliases {
975 try_err!(writeln!(&mut w, "{}", aliases), &dst);
979 use std::ffi::OsString;
984 children: FxHashMap<OsString, Hierarchy>,
985 elems: FxHashSet<OsString>,
989 fn new(elem: OsString) -> Hierarchy {
992 children: FxHashMap::default(),
993 elems: FxHashSet::default(),
997 fn to_json_string(&self) -> String {
998 let mut subs: Vec<&Hierarchy> = self.children.values().collect();
999 subs.sort_unstable_by(|a, b| a.elem.cmp(&b.elem));
1000 let mut files = self.elems.iter()
1001 .map(|s| format!("\"{}\"",
1003 .expect("invalid osstring conversion")))
1004 .collect::<Vec<_>>();
1005 files.sort_unstable_by(|a, b| a.cmp(b));
1006 // FIXME(imperio): we could avoid to generate "dirs" and "files" if they're empty.
1007 format!("{{\"name\":\"{name}\",\"dirs\":[{subs}],\"files\":[{files}]}}",
1008 name=self.elem.to_str().expect("invalid osstring conversion"),
1009 subs=subs.iter().map(|s| s.to_json_string()).collect::<Vec<_>>().join(","),
1010 files=files.join(","))
1014 if cx.shared.include_sources {
1015 use std::path::Component;
1017 let mut hierarchy = Hierarchy::new(OsString::new());
1018 for source in cx.shared.local_sources.iter()
1019 .filter_map(|p| p.0.strip_prefix(&cx.shared.src_root)
1021 let mut h = &mut hierarchy;
1022 let mut elems = source.components()
1025 Component::Normal(s) => Some(s.to_owned()),
1031 let cur_elem = elems.next().expect("empty file path");
1032 if elems.peek().is_none() {
1033 h.elems.insert(cur_elem);
1036 let e = cur_elem.clone();
1037 h.children.entry(cur_elem.clone()).or_insert_with(|| Hierarchy::new(e));
1038 h = h.children.get_mut(&cur_elem).expect("not found child");
1043 let dst = cx.dst.join("source-files.js");
1044 let (mut all_sources, _krates) = try_err!(collect(&dst, &krate.name, "sourcesIndex"), &dst);
1045 all_sources.push(format!("sourcesIndex['{}'] = {};",
1047 hierarchy.to_json_string()));
1049 let mut w = try_err!(File::create(&dst), &dst);
1050 try_err!(writeln!(&mut w,
1051 "var N = null;var sourcesIndex = {{}};\n{}",
1052 all_sources.join("\n")),
1056 // Update the search index
1057 let dst = cx.dst.join("search-index.js");
1058 let (mut all_indexes, mut krates) = try_err!(collect(&dst, &krate.name, "searchIndex"), &dst);
1059 all_indexes.push(search_index);
1061 // Sort the indexes by crate so the file will be generated identically even
1062 // with rustdoc running in parallel.
1064 let mut w = try_err!(File::create(&dst), &dst);
1065 try_err!(writeln!(&mut w, "var N = null;var searchIndex = {{}};"), &dst);
1066 for index in &all_indexes {
1067 try_err!(write_minify_replacer(&mut w, &*index, options.enable_minification,
1068 &[(minifier::js::Keyword::Null, "N")]),
1071 try_err!(writeln!(&mut w, "initSearch(searchIndex);addSearchOptions(searchIndex);"), &dst);
1073 if options.enable_index_page {
1074 if let Some(index_page) = options.index_page.clone() {
1075 let mut md_opts = options.clone();
1076 md_opts.output = cx.dst.clone();
1077 md_opts.external_html = (*cx.shared).layout.external_html.clone();
1079 ::markdown::render(index_page, md_opts, diag);
1081 let dst = cx.dst.join("index.html");
1082 let mut w = BufWriter::new(try_err!(File::create(&dst), &dst));
1083 let page = layout::Page {
1084 title: "Index of crates",
1087 description: "List of crates",
1088 keywords: BASIC_KEYWORDS,
1089 resource_suffix: &cx.shared.resource_suffix,
1091 krates.push(krate.name.clone());
1095 let content = format!(
1097 <span class='in-band'>List of all crates</span>\
1098 </h1><ul class='mod'>{}</ul>",
1102 format!("<li><a href=\"{}/index.html\">{}</li>", s, s)
1104 .collect::<String>());
1105 try_err!(layout::render(&mut w, &cx.shared.layout,
1106 &page, &(""), &content,
1107 cx.shared.css_file_extension.is_some(),
1108 &cx.shared.themes, &[]), &dst);
1109 try_err!(w.flush(), &dst);
1113 // Update the list of all implementors for traits
1114 let dst = cx.dst.join("implementors");
1115 for (&did, imps) in &cache.implementors {
1116 // Private modules can leak through to this phase of rustdoc, which
1117 // could contain implementations for otherwise private types. In some
1118 // rare cases we could find an implementation for an item which wasn't
1119 // indexed, so we just skip this step in that case.
1121 // FIXME: this is a vague explanation for why this can't be a `get`, in
1122 // theory it should be...
1123 let &(ref remote_path, remote_item_type) = match cache.paths.get(&did) {
1125 None => match cache.external_paths.get(&did) {
1131 let mut have_impls = false;
1132 let mut implementors = format!(r#"implementors["{}"] = ["#, krate.name);
1134 // If the trait and implementation are in the same crate, then
1135 // there's no need to emit information about it (there's inlining
1136 // going on). If they're in different crates then the crate defining
1137 // the trait will be interested in our implementation.
1138 if imp.impl_item.def_id.krate == did.krate { continue }
1139 // If the implementation is from another crate then that crate
1141 if !imp.impl_item.def_id.is_local() { continue }
1143 write!(implementors, "{{text:{},synthetic:{},types:{}}},",
1144 as_json(&imp.inner_impl().to_string()),
1145 imp.inner_impl().synthetic,
1146 as_json(&collect_paths_for_type(imp.inner_impl().for_.clone()))).unwrap();
1148 implementors.push_str("];");
1150 // Only create a js file if we have impls to add to it. If the trait is
1151 // documented locally though we always create the file to avoid dead
1153 if !have_impls && !cache.paths.contains_key(&did) {
1157 let mut mydst = dst.clone();
1158 for part in &remote_path[..remote_path.len() - 1] {
1161 try_err!(fs::create_dir_all(&mydst), &mydst);
1162 mydst.push(&format!("{}.{}.js",
1163 remote_item_type.css_class(),
1164 remote_path[remote_path.len() - 1]));
1166 let (mut all_implementors, _) = try_err!(collect(&mydst, &krate.name, "implementors"),
1168 all_implementors.push(implementors);
1169 // Sort the implementors by crate so the file will be generated
1170 // identically even with rustdoc running in parallel.
1171 all_implementors.sort();
1173 let mut f = try_err!(File::create(&mydst), &mydst);
1174 try_err!(writeln!(&mut f, "(function() {{var implementors = {{}};"), &mydst);
1175 for implementor in &all_implementors {
1176 try_err!(writeln!(&mut f, "{}", *implementor), &mydst);
1178 try_err!(writeln!(&mut f, "{}", r"
1179 if (window.register_implementors) {
1180 window.register_implementors(implementors);
1182 window.pending_implementors = implementors;
1185 try_err!(writeln!(&mut f, r"}})()"), &mydst);
1190 fn render_sources(dst: &Path, scx: &mut SharedContext,
1191 krate: clean::Crate) -> Result<clean::Crate, Error> {
1192 info!("emitting source files");
1193 let dst = dst.join("src").join(&krate.name);
1194 try_err!(fs::create_dir_all(&dst), &dst);
1195 let mut folder = SourceCollector {
1199 Ok(folder.fold_crate(krate))
1202 /// Writes the entire contents of a string to a destination, not attempting to
1203 /// catch any errors.
1204 fn write(dst: PathBuf, contents: &[u8]) -> Result<(), Error> {
1205 Ok(try_err!(fs::write(&dst, contents), &dst))
1208 fn write_minify(dst: PathBuf, contents: &str, enable_minification: bool) -> Result<(), Error> {
1209 if enable_minification {
1210 if dst.extension() == Some(&OsStr::new("css")) {
1211 let res = try_none!(minifier::css::minify(contents).ok(), &dst);
1212 write(dst, res.as_bytes())
1214 write(dst, minifier::js::minify(contents).as_bytes())
1217 write(dst, contents.as_bytes())
1221 fn write_minify_replacer<W: Write>(dst: &mut W,
1223 enable_minification: bool,
1224 keywords_to_replace: &[(minifier::js::Keyword, &str)])
1226 if enable_minification {
1228 minifier::js::minify_and_replace_keywords(contents, keywords_to_replace))
1230 writeln!(dst, "{}", contents)
1234 /// Takes a path to a source file and cleans the path to it. This canonicalizes
1235 /// things like ".." to components which preserve the "top down" hierarchy of a
1236 /// static HTML tree. Each component in the cleaned path will be passed as an
1237 /// argument to `f`. The very last component of the path (ie the file name) will
1238 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
1239 // FIXME (#9639): The closure should deal with &[u8] instead of &str
1240 // FIXME (#9639): This is too conservative, rejecting non-UTF-8 paths
1241 fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) where
1244 // make it relative, if possible
1245 let p = p.strip_prefix(src_root).unwrap_or(p);
1247 let mut iter = p.components().peekable();
1249 while let Some(c) = iter.next() {
1250 if !keep_filename && iter.peek().is_none() {
1255 Component::ParentDir => f("up"),
1256 Component::Normal(c) => f(c.to_str().unwrap()),
1262 /// Attempts to find where an external crate is located, given that we're
1263 /// rendering in to the specified source destination.
1264 fn extern_location(e: &clean::ExternalCrate, extern_url: Option<&str>, dst: &Path)
1267 // See if there's documentation generated into the local directory
1268 let local_location = dst.join(&e.name);
1269 if local_location.is_dir() {
1273 if let Some(url) = extern_url {
1274 let mut url = url.to_string();
1275 if !url.ends_with("/") {
1281 // Failing that, see if there's an attribute specifying where to find this
1283 e.attrs.lists("doc")
1284 .filter(|a| a.check_name("html_root_url"))
1285 .filter_map(|a| a.value_str())
1287 let mut url = url.to_string();
1288 if !url.ends_with("/") {
1292 }).next().unwrap_or(Unknown) // Well, at least we tried.
1295 impl<'a> DocFolder for SourceCollector<'a> {
1296 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
1297 // If we're including source files, and we haven't seen this file yet,
1298 // then we need to render it out to the filesystem.
1299 if self.scx.include_sources
1300 // skip all invalid or macro spans
1301 && item.source.filename.is_real()
1302 // skip non-local items
1303 && item.def_id.is_local() {
1305 // If it turns out that we couldn't read this file, then we probably
1306 // can't read any of the files (generating html output from json or
1307 // something like that), so just don't include sources for the
1308 // entire crate. The other option is maintaining this mapping on a
1309 // per-file basis, but that's probably not worth it...
1311 .include_sources = match self.emit_source(&item.source.filename) {
1314 println!("warning: source code was requested to be rendered, \
1315 but processing `{}` had an error: {}",
1316 item.source.filename, e);
1317 println!(" skipping rendering of source code");
1322 self.fold_item_recur(item)
1326 impl<'a> SourceCollector<'a> {
1327 /// Renders the given filename into its corresponding HTML source file.
1328 fn emit_source(&mut self, filename: &FileName) -> io::Result<()> {
1329 let p = match *filename {
1330 FileName::Real(ref file) => file,
1333 if self.scx.local_sources.contains_key(&**p) {
1334 // We've already emitted this source
1338 let contents = fs::read_to_string(&p)?;
1340 // Remove the utf-8 BOM if any
1341 let contents = if contents.starts_with("\u{feff}") {
1347 // Create the intermediate directories
1348 let mut cur = self.dst.clone();
1349 let mut root_path = String::from("../../");
1350 let mut href = String::new();
1351 clean_srcpath(&self.scx.src_root, &p, false, |component| {
1352 cur.push(component);
1353 fs::create_dir_all(&cur).unwrap();
1354 root_path.push_str("../");
1355 href.push_str(component);
1358 let mut fname = p.file_name()
1359 .expect("source has no filename")
1361 fname.push(".html");
1363 href.push_str(&fname.to_string_lossy());
1365 let mut w = BufWriter::new(File::create(&cur)?);
1366 let title = format!("{} -- source", cur.file_name().unwrap()
1367 .to_string_lossy());
1368 let desc = format!("Source to the Rust file `{}`.", filename);
1369 let page = layout::Page {
1371 css_class: "source",
1372 root_path: &root_path,
1374 keywords: BASIC_KEYWORDS,
1375 resource_suffix: &self.scx.resource_suffix,
1377 layout::render(&mut w, &self.scx.layout,
1378 &page, &(""), &Source(contents),
1379 self.scx.css_file_extension.is_some(),
1380 &self.scx.themes, &["source-files",
1381 &format!("source-script{}", page.resource_suffix)])?;
1383 self.scx.local_sources.insert(p.clone(), href);
1388 impl DocFolder for Cache {
1389 fn fold_item(&mut self, item: clean::Item) -> Option<clean::Item> {
1390 if item.def_id.is_local() {
1391 debug!("folding {} \"{:?}\", id {:?}", item.type_(), item.name, item.def_id);
1394 // If this is a stripped module,
1395 // we don't want it or its children in the search index.
1396 let orig_stripped_mod = match item.inner {
1397 clean::StrippedItem(box clean::ModuleItem(..)) => {
1398 mem::replace(&mut self.stripped_mod, true)
1400 _ => self.stripped_mod,
1403 // If the impl is from a masked crate or references something from a
1404 // masked crate then remove it completely.
1405 if let clean::ImplItem(ref i) = item.inner {
1406 if self.masked_crates.contains(&item.def_id.krate) ||
1407 i.trait_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) ||
1408 i.for_.def_id().map_or(false, |d| self.masked_crates.contains(&d.krate)) {
1413 // Register any generics to their corresponding string. This is used
1414 // when pretty-printing types.
1415 if let Some(generics) = item.inner.generics() {
1416 self.generics(generics);
1419 // Propagate a trait method's documentation to all implementors of the
1421 if let clean::TraitItem(ref t) = item.inner {
1422 self.traits.entry(item.def_id).or_insert_with(|| t.clone());
1425 // Collect all the implementors of traits.
1426 if let clean::ImplItem(ref i) = item.inner {
1427 if let Some(did) = i.trait_.def_id() {
1428 if i.blanket_impl.is_none() {
1429 self.implementors.entry(did).or_default().push(Impl {
1430 impl_item: item.clone(),
1436 // Index this method for searching later on.
1437 if let Some(ref s) = item.name {
1438 let (parent, is_inherent_impl_item) = match item.inner {
1439 clean::StrippedItem(..) => ((None, None), false),
1440 clean::AssociatedConstItem(..) |
1441 clean::TypedefItem(_, true) if self.parent_is_trait_impl => {
1442 // skip associated items in trait impls
1443 ((None, None), false)
1445 clean::AssociatedTypeItem(..) |
1446 clean::TyMethodItem(..) |
1447 clean::StructFieldItem(..) |
1448 clean::VariantItem(..) => {
1449 ((Some(*self.parent_stack.last().unwrap()),
1450 Some(&self.stack[..self.stack.len() - 1])),
1453 clean::MethodItem(..) | clean::AssociatedConstItem(..) => {
1454 if self.parent_stack.is_empty() {
1455 ((None, None), false)
1457 let last = self.parent_stack.last().unwrap();
1459 let path = match self.paths.get(&did) {
1460 // The current stack not necessarily has correlation
1461 // for where the type was defined. On the other
1462 // hand, `paths` always has the right
1463 // information if present.
1464 Some(&(ref fqp, ItemType::Trait)) |
1465 Some(&(ref fqp, ItemType::Struct)) |
1466 Some(&(ref fqp, ItemType::Union)) |
1467 Some(&(ref fqp, ItemType::Enum)) =>
1468 Some(&fqp[..fqp.len() - 1]),
1469 Some(..) => Some(&*self.stack),
1472 ((Some(*last), path), true)
1475 _ => ((None, Some(&*self.stack)), false)
1479 (parent, Some(path)) if is_inherent_impl_item || (!self.stripped_mod) => {
1480 debug_assert!(!item.is_stripped());
1482 // A crate has a module at its root, containing all items,
1483 // which should not be indexed. The crate-item itself is
1484 // inserted later on when serializing the search-index.
1485 if item.def_id.index != CRATE_DEF_INDEX {
1486 self.search_index.push(IndexItem {
1488 name: s.to_string(),
1489 path: path.join("::"),
1490 desc: plain_summary_line(item.doc_value()),
1493 search_type: get_index_search_type(&item),
1497 (Some(parent), None) if is_inherent_impl_item => {
1498 // We have a parent, but we don't know where they're
1499 // defined yet. Wait for later to index this item.
1500 self.orphan_impl_items.push((parent, item.clone()));
1506 // Keep track of the fully qualified path for this item.
1507 let pushed = match item.name {
1508 Some(ref n) if !n.is_empty() => {
1509 self.stack.push(n.to_string());
1516 clean::StructItem(..) | clean::EnumItem(..) |
1517 clean::TypedefItem(..) | clean::TraitItem(..) |
1518 clean::FunctionItem(..) | clean::ModuleItem(..) |
1519 clean::ForeignFunctionItem(..) | clean::ForeignStaticItem(..) |
1520 clean::ConstantItem(..) | clean::StaticItem(..) |
1521 clean::UnionItem(..) | clean::ForeignTypeItem | clean::MacroItem(..)
1522 if !self.stripped_mod => {
1523 // Re-exported items mean that the same id can show up twice
1524 // in the rustdoc ast that we're looking at. We know,
1525 // however, that a re-exported item doesn't show up in the
1526 // `public_items` map, so we can skip inserting into the
1527 // paths map if there was already an entry present and we're
1528 // not a public item.
1529 if !self.paths.contains_key(&item.def_id) ||
1530 self.access_levels.is_public(item.def_id)
1532 self.paths.insert(item.def_id,
1533 (self.stack.clone(), item.type_()));
1535 self.add_aliases(&item);
1537 // Link variants to their parent enum because pages aren't emitted
1538 // for each variant.
1539 clean::VariantItem(..) if !self.stripped_mod => {
1540 let mut stack = self.stack.clone();
1542 self.paths.insert(item.def_id, (stack, ItemType::Enum));
1545 clean::PrimitiveItem(..) if item.visibility.is_some() => {
1546 self.add_aliases(&item);
1547 self.paths.insert(item.def_id, (self.stack.clone(),
1554 // Maintain the parent stack
1555 let orig_parent_is_trait_impl = self.parent_is_trait_impl;
1556 let parent_pushed = match item.inner {
1557 clean::TraitItem(..) | clean::EnumItem(..) | clean::ForeignTypeItem |
1558 clean::StructItem(..) | clean::UnionItem(..) => {
1559 self.parent_stack.push(item.def_id);
1560 self.parent_is_trait_impl = false;
1563 clean::ImplItem(ref i) => {
1564 self.parent_is_trait_impl = i.trait_.is_some();
1566 clean::ResolvedPath{ did, .. } => {
1567 self.parent_stack.push(did);
1571 let prim_did = t.primitive_type().and_then(|t| {
1572 self.primitive_locations.get(&t).cloned()
1576 self.parent_stack.push(did);
1587 // Once we've recursively found all the generics, hoard off all the
1588 // implementations elsewhere.
1589 let ret = self.fold_item_recur(item).and_then(|item| {
1590 if let clean::Item { inner: clean::ImplItem(_), .. } = item {
1591 // Figure out the id of this impl. This may map to a
1592 // primitive rather than always to a struct/enum.
1593 // Note: matching twice to restrict the lifetime of the `i` borrow.
1594 let mut dids = FxHashSet::default();
1595 if let clean::Item { inner: clean::ImplItem(ref i), .. } = item {
1597 clean::ResolvedPath { did, .. } |
1598 clean::BorrowedRef {
1599 type_: box clean::ResolvedPath { did, .. }, ..
1604 let did = t.primitive_type().and_then(|t| {
1605 self.primitive_locations.get(&t).cloned()
1608 if let Some(did) = did {
1614 if let Some(generics) = i.trait_.as_ref().and_then(|t| t.generics()) {
1615 for bound in generics {
1616 if let Some(did) = bound.def_id() {
1624 let impl_item = Impl {
1627 if impl_item.trait_did().map_or(true, |d| self.traits.contains_key(&d)) {
1629 self.impls.entry(did).or_insert(vec![]).push(impl_item.clone());
1632 let trait_did = impl_item.trait_did().unwrap();
1633 self.orphan_trait_impls.push((trait_did, dids, impl_item));
1641 if pushed { self.stack.pop().unwrap(); }
1642 if parent_pushed { self.parent_stack.pop().unwrap(); }
1643 self.stripped_mod = orig_stripped_mod;
1644 self.parent_is_trait_impl = orig_parent_is_trait_impl;
1650 fn generics(&mut self, generics: &clean::Generics) {
1651 for param in &generics.params {
1653 clean::GenericParamDefKind::Lifetime => {}
1654 clean::GenericParamDefKind::Type { did, .. } => {
1655 self.typarams.insert(did, param.name.clone());
1661 fn add_aliases(&mut self, item: &clean::Item) {
1662 if item.def_id.index == CRATE_DEF_INDEX {
1665 if let Some(ref item_name) = item.name {
1666 let path = self.paths.get(&item.def_id)
1667 .map(|p| p.0[..p.0.len() - 1].join("::"))
1668 .unwrap_or("std".to_owned());
1669 for alias in item.attrs.lists("doc")
1670 .filter(|a| a.check_name("alias"))
1671 .filter_map(|a| a.value_str()
1672 .map(|s| s.to_string().replace("\"", "")))
1673 .filter(|v| !v.is_empty())
1674 .collect::<FxHashSet<_>>()
1676 self.aliases.entry(alias)
1677 .or_insert(Vec::with_capacity(1))
1680 name: item_name.to_string(),
1682 desc: plain_summary_line(item.doc_value()),
1685 search_type: get_index_search_type(&item),
1692 #[derive(Debug, Eq, PartialEq, Hash)]
1699 fn new(mut url: String, name: String) -> ItemEntry {
1700 while url.starts_with('/') {
1710 impl fmt::Display for ItemEntry {
1711 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1712 write!(f, "<a href='{}'>{}</a>", self.url, Escape(&self.name))
1716 impl PartialOrd for ItemEntry {
1717 fn partial_cmp(&self, other: &ItemEntry) -> Option<::std::cmp::Ordering> {
1718 Some(self.cmp(other))
1722 impl Ord for ItemEntry {
1723 fn cmp(&self, other: &ItemEntry) -> ::std::cmp::Ordering {
1724 self.name.cmp(&other.name)
1730 structs: FxHashSet<ItemEntry>,
1731 enums: FxHashSet<ItemEntry>,
1732 unions: FxHashSet<ItemEntry>,
1733 primitives: FxHashSet<ItemEntry>,
1734 traits: FxHashSet<ItemEntry>,
1735 macros: FxHashSet<ItemEntry>,
1736 functions: FxHashSet<ItemEntry>,
1737 typedefs: FxHashSet<ItemEntry>,
1738 existentials: FxHashSet<ItemEntry>,
1739 statics: FxHashSet<ItemEntry>,
1740 constants: FxHashSet<ItemEntry>,
1741 keywords: FxHashSet<ItemEntry>,
1742 attributes: FxHashSet<ItemEntry>,
1743 derives: FxHashSet<ItemEntry>,
1747 fn new() -> AllTypes {
1748 let new_set = |cap| FxHashSet::with_capacity_and_hasher(cap, Default::default());
1750 structs: new_set(100),
1751 enums: new_set(100),
1752 unions: new_set(100),
1753 primitives: new_set(26),
1754 traits: new_set(100),
1755 macros: new_set(100),
1756 functions: new_set(100),
1757 typedefs: new_set(100),
1758 existentials: new_set(100),
1759 statics: new_set(100),
1760 constants: new_set(100),
1761 keywords: new_set(100),
1762 attributes: new_set(100),
1763 derives: new_set(100),
1767 fn append(&mut self, item_name: String, item_type: &ItemType) {
1768 let mut url: Vec<_> = item_name.split("::").skip(1).collect();
1769 if let Some(name) = url.pop() {
1770 let new_url = format!("{}/{}.{}.html", url.join("/"), item_type, name);
1772 let name = url.join("::");
1774 ItemType::Struct => self.structs.insert(ItemEntry::new(new_url, name)),
1775 ItemType::Enum => self.enums.insert(ItemEntry::new(new_url, name)),
1776 ItemType::Union => self.unions.insert(ItemEntry::new(new_url, name)),
1777 ItemType::Primitive => self.primitives.insert(ItemEntry::new(new_url, name)),
1778 ItemType::Trait => self.traits.insert(ItemEntry::new(new_url, name)),
1779 ItemType::Macro => self.macros.insert(ItemEntry::new(new_url, name)),
1780 ItemType::Function => self.functions.insert(ItemEntry::new(new_url, name)),
1781 ItemType::Typedef => self.typedefs.insert(ItemEntry::new(new_url, name)),
1782 ItemType::Existential => self.existentials.insert(ItemEntry::new(new_url, name)),
1783 ItemType::Static => self.statics.insert(ItemEntry::new(new_url, name)),
1784 ItemType::Constant => self.constants.insert(ItemEntry::new(new_url, name)),
1785 ItemType::ProcAttribute => self.attributes.insert(ItemEntry::new(new_url, name)),
1786 ItemType::ProcDerive => self.derives.insert(ItemEntry::new(new_url, name)),
1793 fn print_entries(f: &mut fmt::Formatter, e: &FxHashSet<ItemEntry>, title: &str,
1794 class: &str) -> fmt::Result {
1796 let mut e: Vec<&ItemEntry> = e.iter().collect();
1798 write!(f, "<h3 id='{}'>{}</h3><ul class='{} docblock'>{}</ul>",
1802 e.iter().map(|s| format!("<li>{}</li>", s)).collect::<String>())?;
1807 impl fmt::Display for AllTypes {
1808 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1811 <span class='out-of-band'>\
1812 <span id='render-detail'>\
1813 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" title=\"collapse all docs\">\
1814 [<span class='inner'>−</span>]\
1818 <span class='in-band'>List of all items</span>\
1820 print_entries(f, &self.structs, "Structs", "structs")?;
1821 print_entries(f, &self.enums, "Enums", "enums")?;
1822 print_entries(f, &self.unions, "Unions", "unions")?;
1823 print_entries(f, &self.primitives, "Primitives", "primitives")?;
1824 print_entries(f, &self.traits, "Traits", "traits")?;
1825 print_entries(f, &self.macros, "Macros", "macros")?;
1826 print_entries(f, &self.attributes, "Attribute Macros", "attributes")?;
1827 print_entries(f, &self.derives, "Derive Macros", "derives")?;
1828 print_entries(f, &self.functions, "Functions", "functions")?;
1829 print_entries(f, &self.typedefs, "Typedefs", "typedefs")?;
1830 print_entries(f, &self.existentials, "Existentials", "existentials")?;
1831 print_entries(f, &self.statics, "Statics", "statics")?;
1832 print_entries(f, &self.constants, "Constants", "constants")
1837 struct Settings<'a> {
1838 // (id, explanation, default value)
1839 settings: Vec<(&'static str, &'static str, bool)>,
1844 impl<'a> Settings<'a> {
1845 pub fn new(root_path: &'a str, suffix: &'a str) -> Settings<'a> {
1848 ("item-declarations", "Auto-hide item declarations.", true),
1849 ("item-attributes", "Auto-hide item attributes.", true),
1850 ("trait-implementations", "Auto-hide trait implementations documentation",
1852 ("method-docs", "Auto-hide item methods' documentation", false),
1853 ("go-to-only-result", "Directly go to item in search if there is only one result",
1855 ("line-numbers", "Show line numbers on code examples", false),
1863 impl<'a> fmt::Display for Settings<'a> {
1864 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1867 <span class='in-band'>Rustdoc settings</span>\
1869 <div class='settings'>{}</div>\
1870 <script src='{}settings{}.js'></script>",
1871 self.settings.iter()
1872 .map(|(id, text, enabled)| {
1873 format!("<div class='setting-line'>\
1874 <label class='toggle'>\
1875 <input type='checkbox' id='{}' {}>\
1876 <span class='slider'></span>\
1879 </div>", id, if *enabled { " checked" } else { "" }, text)
1881 .collect::<String>(),
1888 fn derive_id(&self, id: String) -> String {
1889 let mut map = self.id_map.borrow_mut();
1893 /// String representation of how to get back to the root path of the 'doc/'
1894 /// folder in terms of a relative URL.
1895 fn root_path(&self) -> String {
1896 "../".repeat(self.current.len())
1899 /// Recurse in the directory structure and change the "root path" to make
1900 /// sure it always points to the top (relatively).
1901 fn recurse<T, F>(&mut self, s: String, f: F) -> T where
1902 F: FnOnce(&mut Context) -> T,
1905 panic!("Unexpected empty destination: {:?}", self.current);
1907 let prev = self.dst.clone();
1909 self.current.push(s);
1911 info!("Recursing into {}", self.dst.display());
1915 info!("Recursed; leaving {}", self.dst.display());
1917 // Go back to where we were at
1919 self.current.pop().unwrap();
1924 /// Main method for rendering a crate.
1926 /// This currently isn't parallelized, but it'd be pretty easy to add
1927 /// parallelization to this function.
1928 fn krate(self, mut krate: clean::Crate) -> Result<(), Error> {
1929 let mut item = match krate.module.take() {
1931 None => return Ok(()),
1933 let final_file = self.dst.join(&krate.name)
1935 let settings_file = self.dst.join("settings.html");
1937 let crate_name = krate.name.clone();
1938 item.name = Some(krate.name);
1940 let mut all = AllTypes::new();
1943 // Render the crate documentation
1944 let mut work = vec![(self.clone(), item)];
1946 while let Some((mut cx, item)) = work.pop() {
1947 cx.item(item, &mut all, |cx, item| {
1948 work.push((cx.clone(), item))
1953 let mut w = BufWriter::new(try_err!(File::create(&final_file), &final_file));
1954 let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
1955 if !root_path.ends_with('/') {
1956 root_path.push('/');
1958 let mut page = layout::Page {
1959 title: "List of all items in this crate",
1962 description: "List of all items in this crate",
1963 keywords: BASIC_KEYWORDS,
1964 resource_suffix: &self.shared.resource_suffix,
1966 let sidebar = if let Some(ref version) = cache().crate_version {
1967 format!("<p class='location'>Crate {}</p>\
1968 <div class='block version'>\
1971 <a id='all-types' href='index.html'><p>Back to index</p></a>",
1972 crate_name, version)
1976 try_err!(layout::render(&mut w, &self.shared.layout,
1977 &page, &sidebar, &all,
1978 self.shared.css_file_extension.is_some(),
1979 &self.shared.themes, &[]),
1982 // Generating settings page.
1983 let settings = Settings::new("./", &self.shared.resource_suffix);
1984 page.title = "Rustdoc settings";
1985 page.description = "Settings of Rustdoc";
1986 page.root_path = "./";
1988 let mut w = BufWriter::new(try_err!(File::create(&settings_file), &settings_file));
1989 let mut themes = self.shared.themes.clone();
1990 let sidebar = "<p class='location'>Settings</p><div class='sidebar-elems'></div>";
1991 themes.push(PathBuf::from("settings.css"));
1992 let mut layout = self.shared.layout.clone();
1993 layout.krate = String::new();
1994 layout.logo = String::new();
1995 layout.favicon = String::new();
1996 try_err!(layout::render(&mut w, &layout,
1997 &page, &sidebar, &settings,
1998 self.shared.css_file_extension.is_some(),
2005 fn render_item(&self,
2006 writer: &mut dyn io::Write,
2010 // A little unfortunate that this is done like this, but it sure
2011 // does make formatting *a lot* nicer.
2012 CURRENT_LOCATION_KEY.with(|slot| {
2013 *slot.borrow_mut() = self.current.clone();
2016 let mut title = if it.is_primitive() || it.is_keyword() {
2017 // No need to include the namespace for primitive types and keywords
2020 self.current.join("::")
2023 if !title.is_empty() {
2024 title.push_str("::");
2026 title.push_str(it.name.as_ref().unwrap());
2028 title.push_str(" - Rust");
2029 let tyname = it.type_().css_class();
2030 let desc = if it.is_crate() {
2031 format!("API documentation for the Rust `{}` crate.",
2032 self.shared.layout.krate)
2034 format!("API documentation for the Rust `{}` {} in crate `{}`.",
2035 it.name.as_ref().unwrap(), tyname, self.shared.layout.krate)
2037 let keywords = make_item_keywords(it);
2038 let page = layout::Page {
2040 root_path: &self.root_path(),
2043 keywords: &keywords,
2044 resource_suffix: &self.shared.resource_suffix,
2048 self.id_map.borrow_mut().reset();
2049 self.id_map.borrow_mut().populate(initial_ids());
2052 if !self.render_redirect_pages {
2053 layout::render(writer, &self.shared.layout, &page,
2054 &Sidebar{ cx: self, item: it },
2055 &Item{ cx: self, item: it },
2056 self.shared.css_file_extension.is_some(),
2057 &self.shared.themes, &[])?;
2059 let mut url = self.root_path();
2060 if let Some(&(ref names, ty)) = cache().paths.get(&it.def_id) {
2061 for name in &names[..names.len() - 1] {
2065 url.push_str(&item_path(ty, names.last().unwrap()));
2066 layout::redirect(writer, &url)?;
2072 /// Non-parallelized version of rendering an item. This will take the input
2073 /// item, render its contents, and then invoke the specified closure with
2074 /// all sub-items which need to be rendered.
2076 /// The rendering driver uses this closure to queue up more work.
2077 fn item<F>(&mut self, item: clean::Item, all: &mut AllTypes, mut f: F) -> Result<(), Error>
2078 where F: FnMut(&mut Context, clean::Item),
2080 // Stripped modules survive the rustdoc passes (i.e., `strip-private`)
2081 // if they contain impls for public types. These modules can also
2082 // contain items such as publicly re-exported structures.
2084 // External crates will provide links to these structures, so
2085 // these modules are recursed into, but not rendered normally
2086 // (a flag on the context).
2087 if !self.render_redirect_pages {
2088 self.render_redirect_pages = item.is_stripped();
2092 // modules are special because they add a namespace. We also need to
2093 // recurse into the items of the module as well.
2094 let name = item.name.as_ref().unwrap().to_string();
2095 let mut item = Some(item);
2096 self.recurse(name, |this| {
2097 let item = item.take().unwrap();
2099 let mut buf = Vec::new();
2100 this.render_item(&mut buf, &item, false).unwrap();
2101 // buf will be empty if the module is stripped and there is no redirect for it
2102 if !buf.is_empty() {
2103 try_err!(this.shared.ensure_dir(&this.dst), &this.dst);
2104 let joint_dst = this.dst.join("index.html");
2105 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
2106 try_err!(dst.write_all(&buf), &joint_dst);
2109 let m = match item.inner {
2110 clean::StrippedItem(box clean::ModuleItem(m)) |
2111 clean::ModuleItem(m) => m,
2115 // Render sidebar-items.js used throughout this module.
2116 if !this.render_redirect_pages {
2117 let items = this.build_sidebar_items(&m);
2118 let js_dst = this.dst.join("sidebar-items.js");
2119 let mut js_out = BufWriter::new(try_err!(File::create(&js_dst), &js_dst));
2120 try_err!(write!(&mut js_out, "initSidebarItems({});",
2121 as_json(&items)), &js_dst);
2124 for item in m.items {
2130 } else if item.name.is_some() {
2131 let mut buf = Vec::new();
2132 self.render_item(&mut buf, &item, true).unwrap();
2133 // buf will be empty if the item is stripped and there is no redirect for it
2134 if !buf.is_empty() {
2135 let name = item.name.as_ref().unwrap();
2136 let item_type = item.type_();
2137 let file_name = &item_path(item_type, name);
2138 try_err!(self.shared.ensure_dir(&self.dst), &self.dst);
2139 let joint_dst = self.dst.join(file_name);
2140 let mut dst = try_err!(File::create(&joint_dst), &joint_dst);
2141 try_err!(dst.write_all(&buf), &joint_dst);
2143 if !self.render_redirect_pages {
2144 all.append(full_path(self, &item), &item_type);
2146 // Redirect from a sane URL using the namespace to Rustdoc's
2147 // URL for the page.
2148 let redir_name = format!("{}.{}.html", name, item_type.name_space());
2149 let redir_dst = self.dst.join(redir_name);
2150 if let Ok(redirect_out) = OpenOptions::new().create_new(true)
2153 let mut redirect_out = BufWriter::new(redirect_out);
2154 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
2157 // If the item is a macro, redirect from the old macro URL (with !)
2158 // to the new one (without).
2159 if item_type == ItemType::Macro {
2160 let redir_name = format!("{}.{}!.html", item_type, name);
2161 let redir_dst = self.dst.join(redir_name);
2162 let redirect_out = try_err!(File::create(&redir_dst), &redir_dst);
2163 let mut redirect_out = BufWriter::new(redirect_out);
2164 try_err!(layout::redirect(&mut redirect_out, file_name), &redir_dst);
2171 fn build_sidebar_items(&self, m: &clean::Module) -> BTreeMap<String, Vec<NameDoc>> {
2172 // BTreeMap instead of HashMap to get a sorted output
2173 let mut map: BTreeMap<_, Vec<_>> = BTreeMap::new();
2174 for item in &m.items {
2175 if item.is_stripped() { continue }
2177 let short = item.type_().css_class();
2178 let myname = match item.name {
2180 Some(ref s) => s.to_string(),
2182 let short = short.to_string();
2183 map.entry(short).or_default()
2184 .push((myname, Some(plain_summary_line(item.doc_value()))));
2187 if self.shared.sort_modules_alphabetically {
2188 for (_, items) in &mut map {
2197 /// Generate a url appropriate for an `href` attribute back to the source of
2200 /// The url generated, when clicked, will redirect the browser back to the
2201 /// original source code.
2203 /// If `None` is returned, then a source link couldn't be generated. This
2204 /// may happen, for example, with externally inlined items where the source
2205 /// of their crate documentation isn't known.
2206 fn src_href(&self) -> Option<String> {
2207 let mut root = self.cx.root_path();
2209 let cache = cache();
2210 let mut path = String::new();
2212 // We can safely ignore macros from other libraries
2213 let file = match self.item.source.filename {
2214 FileName::Real(ref path) => path,
2218 let (krate, path) = if self.item.def_id.is_local() {
2219 if let Some(path) = self.cx.shared.local_sources.get(file) {
2220 (&self.cx.shared.layout.krate, path)
2225 let (krate, src_root) = match *cache.extern_locations.get(&self.item.def_id.krate)? {
2226 (ref name, ref src, Local) => (name, src),
2227 (ref name, ref src, Remote(ref s)) => {
2228 root = s.to_string();
2231 (_, _, Unknown) => return None,
2234 clean_srcpath(&src_root, file, false, |component| {
2235 path.push_str(component);
2238 let mut fname = file.file_name().expect("source has no filename")
2240 fname.push(".html");
2241 path.push_str(&fname.to_string_lossy());
2245 let lines = if self.item.source.loline == self.item.source.hiline {
2246 self.item.source.loline.to_string()
2248 format!("{}-{}", self.item.source.loline, self.item.source.hiline)
2250 Some(format!("{root}src/{krate}/{path}#{lines}",
2251 root = Escape(&root),
2258 fn wrap_into_docblock<F>(w: &mut fmt::Formatter,
2259 f: F) -> fmt::Result
2260 where F: Fn(&mut fmt::Formatter) -> fmt::Result {
2261 write!(w, "<div class=\"docblock type-decl hidden-by-usual-hider\">")?;
2266 impl<'a> fmt::Display for Item<'a> {
2267 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
2268 debug_assert!(!self.item.is_stripped());
2269 // Write the breadcrumb trail header for the top
2270 write!(fmt, "<h1 class='fqn'><span class='out-of-band'>")?;
2271 if let Some(version) = self.item.stable_since() {
2272 write!(fmt, "<span class='since' title='Stable since Rust version {0}'>{0}</span>",
2276 "<span id='render-detail'>\
2277 <a id=\"toggle-all-docs\" href=\"javascript:void(0)\" \
2278 title=\"collapse all docs\">\
2279 [<span class='inner'>−</span>]\
2285 // When this item is part of a `pub use` in a downstream crate, the
2286 // [src] link in the downstream documentation will actually come back to
2287 // this page, and this link will be auto-clicked. The `id` attribute is
2288 // used to find the link to auto-click.
2289 if self.cx.shared.include_sources && !self.item.is_primitive() {
2290 if let Some(l) = self.src_href() {
2291 write!(fmt, "<a class='srclink' href='{}' title='{}'>[src]</a>",
2292 l, "goto source code")?;
2296 write!(fmt, "</span>")?; // out-of-band
2297 write!(fmt, "<span class='in-band'>")?;
2298 match self.item.inner {
2299 clean::ModuleItem(ref m) => if m.is_crate {
2300 write!(fmt, "Crate ")?;
2302 write!(fmt, "Module ")?;
2304 clean::FunctionItem(..) | clean::ForeignFunctionItem(..) => write!(fmt, "Function ")?,
2305 clean::TraitItem(..) => write!(fmt, "Trait ")?,
2306 clean::StructItem(..) => write!(fmt, "Struct ")?,
2307 clean::UnionItem(..) => write!(fmt, "Union ")?,
2308 clean::EnumItem(..) => write!(fmt, "Enum ")?,
2309 clean::TypedefItem(..) => write!(fmt, "Type Definition ")?,
2310 clean::MacroItem(..) => write!(fmt, "Macro ")?,
2311 clean::ProcMacroItem(ref mac) => match mac.kind {
2312 MacroKind::Bang => write!(fmt, "Macro ")?,
2313 MacroKind::Attr => write!(fmt, "Attribute Macro ")?,
2314 MacroKind::Derive => write!(fmt, "Derive Macro ")?,
2315 MacroKind::ProcMacroStub => unreachable!(),
2317 clean::PrimitiveItem(..) => write!(fmt, "Primitive Type ")?,
2318 clean::StaticItem(..) | clean::ForeignStaticItem(..) => write!(fmt, "Static ")?,
2319 clean::ConstantItem(..) => write!(fmt, "Constant ")?,
2320 clean::ForeignTypeItem => write!(fmt, "Foreign Type ")?,
2321 clean::KeywordItem(..) => write!(fmt, "Keyword ")?,
2322 clean::ExistentialItem(..) => write!(fmt, "Existential Type ")?,
2324 // We don't generate pages for any other type.
2328 if !self.item.is_primitive() && !self.item.is_keyword() {
2329 let cur = &self.cx.current;
2330 let amt = if self.item.is_mod() { cur.len() - 1 } else { cur.len() };
2331 for (i, component) in cur.iter().enumerate().take(amt) {
2332 write!(fmt, "<a href='{}index.html'>{}</a>::<wbr>",
2333 "../".repeat(cur.len() - i - 1),
2337 write!(fmt, "<a class=\"{}\" href=''>{}</a>",
2338 self.item.type_(), self.item.name.as_ref().unwrap())?;
2340 write!(fmt, "</span></h1>")?; // in-band
2342 match self.item.inner {
2343 clean::ModuleItem(ref m) =>
2344 item_module(fmt, self.cx, self.item, &m.items),
2345 clean::FunctionItem(ref f) | clean::ForeignFunctionItem(ref f) =>
2346 item_function(fmt, self.cx, self.item, f),
2347 clean::TraitItem(ref t) => item_trait(fmt, self.cx, self.item, t),
2348 clean::StructItem(ref s) => item_struct(fmt, self.cx, self.item, s),
2349 clean::UnionItem(ref s) => item_union(fmt, self.cx, self.item, s),
2350 clean::EnumItem(ref e) => item_enum(fmt, self.cx, self.item, e),
2351 clean::TypedefItem(ref t, _) => item_typedef(fmt, self.cx, self.item, t),
2352 clean::MacroItem(ref m) => item_macro(fmt, self.cx, self.item, m),
2353 clean::ProcMacroItem(ref m) => item_proc_macro(fmt, self.cx, self.item, m),
2354 clean::PrimitiveItem(ref p) => item_primitive(fmt, self.cx, self.item, p),
2355 clean::StaticItem(ref i) | clean::ForeignStaticItem(ref i) =>
2356 item_static(fmt, self.cx, self.item, i),
2357 clean::ConstantItem(ref c) => item_constant(fmt, self.cx, self.item, c),
2358 clean::ForeignTypeItem => item_foreign_type(fmt, self.cx, self.item),
2359 clean::KeywordItem(ref k) => item_keyword(fmt, self.cx, self.item, k),
2360 clean::ExistentialItem(ref e, _) => item_existential(fmt, self.cx, self.item, e),
2362 // We don't generate pages for any other type.
2369 fn item_path(ty: ItemType, name: &str) -> String {
2371 ItemType::Module => format!("{}/index.html", name),
2372 _ => format!("{}.{}.html", ty.css_class(), name),
2376 fn full_path(cx: &Context, item: &clean::Item) -> String {
2377 let mut s = cx.current.join("::");
2379 s.push_str(item.name.as_ref().unwrap());
2383 fn shorter<'a>(s: Option<&'a str>) -> String {
2385 Some(s) => s.lines()
2386 .skip_while(|s| s.chars().all(|c| c.is_whitespace()))
2388 (*line).chars().any(|chr|{
2389 !chr.is_whitespace()
2391 }).collect::<Vec<_>>().join("\n"),
2392 None => String::new()
2397 fn plain_summary_line(s: Option<&str>) -> String {
2398 let line = shorter(s).replace("\n", " ");
2399 markdown::plain_summary_line(&line[..])
2402 fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
2403 if let Some(ref name) = item.name {
2404 info!("Documenting {}", name);
2406 document_stability(w, cx, item, false)?;
2407 document_full(w, item, cx, "", false)?;
2411 /// Render md_text as markdown.
2412 fn render_markdown(w: &mut fmt::Formatter,
2415 links: Vec<(String, String)>,
2419 let mut ids = cx.id_map.borrow_mut();
2420 write!(w, "<div class='docblock{}'>{}{}</div>",
2421 if is_hidden { " hidden" } else { "" },
2423 Markdown(md_text, &links, RefCell::new(&mut ids),
2427 fn document_short(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item, link: AssocItemLink,
2428 prefix: &str, is_hidden: bool) -> fmt::Result {
2429 if let Some(s) = item.doc_value() {
2430 let markdown = if s.contains('\n') {
2431 format!("{} [Read more]({})",
2432 &plain_summary_line(Some(s)), naive_assoc_href(item, link))
2434 plain_summary_line(Some(s))
2436 render_markdown(w, cx, &markdown, item.links(), prefix, is_hidden)?;
2437 } else if !prefix.is_empty() {
2438 write!(w, "<div class='docblock{}'>{}</div>",
2439 if is_hidden { " hidden" } else { "" },
2445 fn document_full(w: &mut fmt::Formatter, item: &clean::Item,
2446 cx: &Context, prefix: &str, is_hidden: bool) -> fmt::Result {
2447 if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
2448 debug!("Doc block: =====\n{}\n=====", s);
2449 render_markdown(w, cx, &*s, item.links(), prefix, is_hidden)?;
2450 } else if !prefix.is_empty() {
2451 write!(w, "<div class='docblock{}'>{}</div>",
2452 if is_hidden { " hidden" } else { "" },
2458 fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
2459 is_hidden: bool) -> fmt::Result {
2460 let stabilities = short_stability(item, cx, true);
2461 if !stabilities.is_empty() {
2462 write!(w, "<div class='stability{}'>", if is_hidden { " hidden" } else { "" })?;
2463 for stability in stabilities {
2464 write!(w, "{}", stability)?;
2466 write!(w, "</div>")?;
2471 fn document_non_exhaustive_header(item: &clean::Item) -> &str {
2472 if item.is_non_exhaustive() { " (Non-exhaustive)" } else { "" }
2475 fn document_non_exhaustive(w: &mut fmt::Formatter, item: &clean::Item) -> fmt::Result {
2476 if item.is_non_exhaustive() {
2477 write!(w, "<div class='docblock non-exhaustive non-exhaustive-{}'>", {
2478 if item.is_struct() { "struct" } else if item.is_enum() { "enum" } else { "type" }
2481 if item.is_struct() {
2482 write!(w, "Non-exhaustive structs could have additional fields added in future. \
2483 Therefore, non-exhaustive structs cannot be constructed in external crates \
2484 using the traditional <code>Struct {{ .. }}</code> syntax; cannot be \
2485 matched against without a wildcard <code>..</code>; and \
2486 struct update syntax will not work.")?;
2487 } else if item.is_enum() {
2488 write!(w, "Non-exhaustive enums could have additional variants added in future. \
2489 Therefore, when matching against variants of non-exhaustive enums, an \
2490 extra wildcard arm must be added to account for any future variants.")?;
2492 write!(w, "This type will require a wildcard arm in any match statements or \
2496 write!(w, "</div>")?;
2502 fn name_key(name: &str) -> (&str, u64, usize) {
2503 let end = name.bytes()
2504 .rposition(|b| b.is_ascii_digit()).map_or(name.len(), |i| i + 1);
2506 // find number at end
2507 let split = name[0..end].bytes()
2508 .rposition(|b| !b.is_ascii_digit()).map_or(0, |i| i + 1);
2510 // count leading zeroes
2512 name[split..end].bytes().position(|b| b != b'0').map_or(name.len(), |extra| split + extra);
2514 // sort leading zeroes last
2515 let num_zeroes = after_zeroes - split;
2517 match name[split..end].parse() {
2518 Ok(n) => (&name[..split], n, num_zeroes),
2519 Err(_) => (name, 0, num_zeroes),
2523 fn item_module(w: &mut fmt::Formatter, cx: &Context,
2524 item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
2525 document(w, cx, item)?;
2527 let mut indices = (0..items.len()).filter(|i| !items[*i].is_stripped()).collect::<Vec<usize>>();
2529 // the order of item types in the listing
2530 fn reorder(ty: ItemType) -> u8 {
2532 ItemType::ExternCrate => 0,
2533 ItemType::Import => 1,
2534 ItemType::Primitive => 2,
2535 ItemType::Module => 3,
2536 ItemType::Macro => 4,
2537 ItemType::Struct => 5,
2538 ItemType::Enum => 6,
2539 ItemType::Constant => 7,
2540 ItemType::Static => 8,
2541 ItemType::Trait => 9,
2542 ItemType::Function => 10,
2543 ItemType::Typedef => 12,
2544 ItemType::Union => 13,
2549 fn cmp(i1: &clean::Item, i2: &clean::Item, idx1: usize, idx2: usize) -> Ordering {
2550 let ty1 = i1.type_();
2551 let ty2 = i2.type_();
2553 return (reorder(ty1), idx1).cmp(&(reorder(ty2), idx2))
2555 let s1 = i1.stability.as_ref().map(|s| s.level);
2556 let s2 = i2.stability.as_ref().map(|s| s.level);
2558 (Some(stability::Unstable), Some(stability::Stable)) => return Ordering::Greater,
2559 (Some(stability::Stable), Some(stability::Unstable)) => return Ordering::Less,
2562 let lhs = i1.name.as_ref().map_or("", |s| &**s);
2563 let rhs = i2.name.as_ref().map_or("", |s| &**s);
2564 name_key(lhs).cmp(&name_key(rhs))
2567 if cx.shared.sort_modules_alphabetically {
2568 indices.sort_by(|&i1, &i2| cmp(&items[i1], &items[i2], i1, i2));
2570 // This call is to remove re-export duplicates in cases such as:
2575 // pub trait Double { fn foo(); }
2579 // pub use foo::bar::*;
2583 // `Double` will appear twice in the generated docs.
2585 // FIXME: This code is quite ugly and could be improved. Small issue: DefId
2586 // can be identical even if the elements are different (mostly in imports).
2587 // So in case this is an import, we keep everything by adding a "unique id"
2588 // (which is the position in the vector).
2589 indices.dedup_by_key(|i| (items[*i].def_id,
2590 if items[*i].name.as_ref().is_some() {
2591 Some(full_path(cx, &items[*i]))
2596 if items[*i].is_import() {
2602 debug!("{:?}", indices);
2603 let mut curty = None;
2604 for &idx in &indices {
2605 let myitem = &items[idx];
2606 if myitem.is_stripped() {
2610 let myty = Some(myitem.type_());
2611 if curty == Some(ItemType::ExternCrate) && myty == Some(ItemType::Import) {
2612 // Put `extern crate` and `use` re-exports in the same section.
2614 } else if myty != curty {
2615 if curty.is_some() {
2616 write!(w, "</table>")?;
2619 let (short, name) = item_ty_to_strs(&myty.unwrap());
2620 write!(w, "<h2 id='{id}' class='section-header'>\
2621 <a href=\"#{id}\">{name}</a></h2>\n<table>",
2622 id = cx.derive_id(short.to_owned()), name = name)?;
2625 match myitem.inner {
2626 clean::ExternCrateItem(ref name, ref src) => {
2627 use html::format::HRef;
2631 write!(w, "<tr><td><code>{}extern crate {} as {};",
2632 VisSpace(&myitem.visibility),
2633 HRef::new(myitem.def_id, src),
2637 write!(w, "<tr><td><code>{}extern crate {};",
2638 VisSpace(&myitem.visibility),
2639 HRef::new(myitem.def_id, name))?
2642 write!(w, "</code></td></tr>")?;
2645 clean::ImportItem(ref import) => {
2646 write!(w, "<tr><td><code>{}{}</code></td></tr>",
2647 VisSpace(&myitem.visibility), *import)?;
2651 if myitem.name.is_none() { continue }
2653 let stabilities = short_stability(myitem, cx, false);
2655 let stab_docs = if !stabilities.is_empty() {
2657 .map(|s| format!("[{}]", s))
2658 .collect::<Vec<_>>()
2665 let unsafety_flag = match myitem.inner {
2666 clean::FunctionItem(ref func) | clean::ForeignFunctionItem(ref func)
2667 if func.header.unsafety == hir::Unsafety::Unsafe => {
2668 "<a title='unsafe function' href='#'><sup>âš </sup></a>"
2673 let stab = myitem.stability_class();
2674 let add = if stab.is_some() {
2680 let doc_value = myitem.doc_value().unwrap_or("");
2682 <tr class='{stab}{add}module-item'>\
2683 <td><a class=\"{class}\" href=\"{href}\" \
2684 title='{title}'>{name}</a>{unsafety_flag}</td>\
2685 <td class='docblock-short'>{stab_docs}{docs}\
2688 name = *myitem.name.as_ref().unwrap(),
2689 stab_docs = stab_docs,
2690 docs = MarkdownSummaryLine(doc_value, &myitem.links()),
2691 class = myitem.type_(),
2693 stab = stab.unwrap_or_else(|| String::new()),
2694 unsafety_flag = unsafety_flag,
2695 href = item_path(myitem.type_(), myitem.name.as_ref().unwrap()),
2696 title = [full_path(cx, myitem), myitem.type_().to_string()]
2698 .filter_map(|s| if !s.is_empty() {
2703 .collect::<Vec<_>>()
2710 if curty.is_some() {
2711 write!(w, "</table>")?;
2716 fn short_stability(item: &clean::Item, cx: &Context, show_reason: bool) -> Vec<String> {
2717 let mut stability = vec![];
2718 let error_codes = ErrorCodes::from(UnstableFeatures::from_environment().is_nightly_build());
2720 if let Some(stab) = item.stability.as_ref() {
2721 let deprecated_reason = if show_reason && !stab.deprecated_reason.is_empty() {
2722 format!(": {}", stab.deprecated_reason)
2726 if !stab.deprecated_since.is_empty() {
2727 let since = if show_reason {
2728 format!(" since {}", Escape(&stab.deprecated_since))
2732 let mut ids = cx.id_map.borrow_mut();
2733 let html = MarkdownHtml(&deprecated_reason, RefCell::new(&mut ids), error_codes);
2734 let text = if stability::deprecation_in_effect(&stab.deprecated_since) {
2735 format!("Deprecated{}{}", since, html)
2737 format!("Deprecating in {}{}", Escape(&stab.deprecated_since), html)
2739 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
2742 if stab.level == stability::Unstable {
2744 let unstable_extra = match (!stab.feature.is_empty(),
2745 &cx.shared.issue_tracker_base_url,
2747 (true, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
2748 format!(" (<code>{} </code><a href=\"{}{}\">#{}</a>)",
2749 Escape(&stab.feature), tracker_url, issue_no, issue_no),
2750 (false, &Some(ref tracker_url), Some(issue_no)) if issue_no > 0 =>
2751 format!(" (<a href=\"{}{}\">#{}</a>)", Escape(&tracker_url), issue_no,
2754 format!(" (<code>{}</code>)", Escape(&stab.feature)),
2757 if stab.unstable_reason.is_empty() {
2758 stability.push(format!("<div class='stab unstable'>\
2759 <span class=microscope>🔬</span> \
2760 This is a nightly-only experimental API. {}\
2764 let mut ids = cx.id_map.borrow_mut();
2765 let text = format!("<summary><span class=microscope>🔬</span> \
2766 This is a nightly-only experimental API. {}\
2770 &stab.unstable_reason,
2771 RefCell::new(&mut ids),
2773 stability.push(format!("<div class='stab unstable'><details>{}</details></div>",
2777 stability.push("<div class='stab unstable'>Experimental</div>".to_string())
2780 } else if let Some(depr) = item.deprecation.as_ref() {
2781 let note = if show_reason && !depr.note.is_empty() {
2782 format!(": {}", depr.note)
2786 let since = if show_reason && !depr.since.is_empty() {
2787 format!(" since {}", Escape(&depr.since))
2792 let mut ids = cx.id_map.borrow_mut();
2793 let text = if stability::deprecation_in_effect(&depr.since) {
2794 format!("Deprecated{}{}",
2796 MarkdownHtml(¬e, RefCell::new(&mut ids), error_codes))
2798 format!("Deprecating in {}{}",
2799 Escape(&depr.since),
2800 MarkdownHtml(¬e, RefCell::new(&mut ids), error_codes))
2802 stability.push(format!("<div class='stab deprecated'>{}</div>", text))
2805 if let Some(ref cfg) = item.attrs.cfg {
2806 stability.push(format!("<div class='stab portability'>{}</div>", if show_reason {
2807 cfg.render_long_html()
2809 cfg.render_short_html()
2816 fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2817 c: &clean::Constant) -> fmt::Result {
2818 write!(w, "<pre class='rust const'>")?;
2819 render_attributes(w, it)?;
2820 write!(w, "{vis}const \
2821 {name}: {typ}</pre>",
2822 vis = VisSpace(&it.visibility),
2823 name = it.name.as_ref().unwrap(),
2828 fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2829 s: &clean::Static) -> fmt::Result {
2830 write!(w, "<pre class='rust static'>")?;
2831 render_attributes(w, it)?;
2832 write!(w, "{vis}static {mutability}\
2833 {name}: {typ}</pre>",
2834 vis = VisSpace(&it.visibility),
2835 mutability = MutableSpace(s.mutability),
2836 name = it.name.as_ref().unwrap(),
2841 fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
2842 f: &clean::Function) -> fmt::Result {
2843 let name_len = format!("{}{}{}{}{:#}fn {}{:#}",
2844 VisSpace(&it.visibility),
2845 ConstnessSpace(f.header.constness),
2846 UnsafetySpace(f.header.unsafety),
2847 AsyncSpace(f.header.asyncness),
2848 AbiSpace(f.header.abi),
2849 it.name.as_ref().unwrap(),
2851 write!(w, "{}<pre class='rust fn'>", render_spotlight_traits(it)?)?;
2852 render_attributes(w, it)?;
2854 "{vis}{constness}{unsafety}{asyncness}{abi}fn \
2855 {name}{generics}{decl}{where_clause}</pre>",
2856 vis = VisSpace(&it.visibility),
2857 constness = ConstnessSpace(f.header.constness),
2858 unsafety = UnsafetySpace(f.header.unsafety),
2859 asyncness = AsyncSpace(f.header.asyncness),
2860 abi = AbiSpace(f.header.abi),
2861 name = it.name.as_ref().unwrap(),
2862 generics = f.generics,
2863 where_clause = WhereClause { gens: &f.generics, indent: 0, end_newline: true },
2872 fn render_implementor(cx: &Context, implementor: &Impl, w: &mut fmt::Formatter,
2873 implementor_dups: &FxHashMap<&str, (DefId, bool)>) -> fmt::Result {
2874 // If there's already another implementor that has the same abbridged name, use the
2875 // full path, for example in `std::iter::ExactSizeIterator`
2876 let use_absolute = match implementor.inner_impl().for_ {
2877 clean::ResolvedPath { ref path, is_generic: false, .. } |
2878 clean::BorrowedRef {
2879 type_: box clean::ResolvedPath { ref path, is_generic: false, .. },
2881 } => implementor_dups[path.last_name()].1,
2884 render_impl(w, cx, implementor, AssocItemLink::Anchor(None), RenderMode::Normal,
2885 implementor.impl_item.stable_since(), false, Some(use_absolute))?;
2889 fn render_impls(cx: &Context, w: &mut fmt::Formatter,
2891 containing_item: &clean::Item) -> fmt::Result {
2893 let did = i.trait_did().unwrap();
2894 let assoc_link = AssocItemLink::GotoSource(did, &i.inner_impl().provided_trait_methods);
2895 render_impl(w, cx, i, assoc_link,
2896 RenderMode::Normal, containing_item.stable_since(), true, None)?;
2901 fn bounds(t_bounds: &[clean::GenericBound]) -> String {
2902 let mut bounds = String::new();
2903 let mut bounds_plain = String::new();
2904 if !t_bounds.is_empty() {
2905 if !bounds.is_empty() {
2907 bounds_plain.push(' ');
2909 bounds.push_str(": ");
2910 bounds_plain.push_str(": ");
2911 for (i, p) in t_bounds.iter().enumerate() {
2913 bounds.push_str(" + ");
2914 bounds_plain.push_str(" + ");
2916 bounds.push_str(&(*p).to_string());
2917 bounds_plain.push_str(&format!("{:#}", *p));
2923 fn compare_impl<'a, 'b>(lhs: &'a &&Impl, rhs: &'b &&Impl) -> Ordering {
2924 let lhs = format!("{}", lhs.inner_impl());
2925 let rhs = format!("{}", rhs.inner_impl());
2927 // lhs and rhs are formatted as HTML, which may be unnecessary
2928 name_key(&lhs).cmp(&name_key(&rhs))
2932 w: &mut fmt::Formatter,
2937 let bounds = bounds(&t.bounds);
2938 let types = t.items.iter().filter(|m| m.is_associated_type()).collect::<Vec<_>>();
2939 let consts = t.items.iter().filter(|m| m.is_associated_const()).collect::<Vec<_>>();
2940 let required = t.items.iter().filter(|m| m.is_ty_method()).collect::<Vec<_>>();
2941 let provided = t.items.iter().filter(|m| m.is_method()).collect::<Vec<_>>();
2943 // Output the trait definition
2944 wrap_into_docblock(w, |w| {
2945 write!(w, "<pre class='rust trait'>")?;
2946 render_attributes(w, it)?;
2947 write!(w, "{}{}{}trait {}{}{}",
2948 VisSpace(&it.visibility),
2949 UnsafetySpace(t.unsafety),
2950 if t.is_auto { "auto " } else { "" },
2951 it.name.as_ref().unwrap(),
2955 if !t.generics.where_predicates.is_empty() {
2956 write!(w, "{}", WhereClause { gens: &t.generics, indent: 0, end_newline: true })?;
2961 if t.items.is_empty() {
2962 write!(w, "{{ }}")?;
2964 // FIXME: we should be using a derived_id for the Anchors here
2968 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2971 if !types.is_empty() && !consts.is_empty() {
2976 render_assoc_item(w, t, AssocItemLink::Anchor(None), ItemType::Trait)?;
2979 if !consts.is_empty() && !required.is_empty() {
2982 for (pos, m) in required.iter().enumerate() {
2984 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2987 if pos < required.len() - 1 {
2988 write!(w, "<div class='item-spacer'></div>")?;
2991 if !required.is_empty() && !provided.is_empty() {
2994 for (pos, m) in provided.iter().enumerate() {
2996 render_assoc_item(w, m, AssocItemLink::Anchor(None), ItemType::Trait)?;
2998 clean::MethodItem(ref inner) if !inner.generics.where_predicates.is_empty() => {
2999 write!(w, ",\n {{ ... }}\n")?;
3002 write!(w, " {{ ... }}\n")?;
3005 if pos < provided.len() - 1 {
3006 write!(w, "<div class='item-spacer'></div>")?;
3014 // Trait documentation
3015 document(w, cx, it)?;
3017 fn trait_item(w: &mut fmt::Formatter, cx: &Context, m: &clean::Item, t: &clean::Item)
3019 let name = m.name.as_ref().unwrap();
3020 let item_type = m.type_();
3021 let id = cx.derive_id(format!("{}.{}", item_type, name));
3022 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
3023 write!(w, "{extra}<h3 id='{id}' class='method'>\
3024 <span id='{ns_id}' class='invisible'><code>",
3025 extra = render_spotlight_traits(m)?,
3028 render_assoc_item(w, m, AssocItemLink::Anchor(Some(&id)), ItemType::Impl)?;
3029 write!(w, "</code>")?;
3030 render_stability_since(w, m, t)?;
3031 write!(w, "</span></h3>")?;
3032 document(w, cx, m)?;
3036 if !types.is_empty() {
3038 <h2 id='associated-types' class='small-section-header'>
3039 Associated Types<a href='#associated-types' class='anchor'></a>
3041 <div class='methods'>
3044 trait_item(w, cx, *t, it)?;
3046 write!(w, "</div>")?;
3049 if !consts.is_empty() {
3051 <h2 id='associated-const' class='small-section-header'>
3052 Associated Constants<a href='#associated-const' class='anchor'></a>
3054 <div class='methods'>
3057 trait_item(w, cx, *t, it)?;
3059 write!(w, "</div>")?;
3062 // Output the documentation for each function individually
3063 if !required.is_empty() {
3065 <h2 id='required-methods' class='small-section-header'>
3066 Required Methods<a href='#required-methods' class='anchor'></a>
3068 <div class='methods'>
3070 for m in &required {
3071 trait_item(w, cx, *m, it)?;
3073 write!(w, "</div>")?;
3075 if !provided.is_empty() {
3077 <h2 id='provided-methods' class='small-section-header'>
3078 Provided Methods<a href='#provided-methods' class='anchor'></a>
3080 <div class='methods'>
3082 for m in &provided {
3083 trait_item(w, cx, *m, it)?;
3085 write!(w, "</div>")?;
3088 // If there are methods directly on this trait object, render them here.
3089 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
3091 let cache = cache();
3092 let impl_header = "\
3093 <h2 id='implementors' class='small-section-header'>\
3094 Implementors<a href='#implementors' class='anchor'></a>\
3096 <div class='item-list' id='implementors-list'>\
3099 let synthetic_impl_header = "\
3100 <h2 id='synthetic-implementors' class='small-section-header'>\
3101 Auto implementors<a href='#synthetic-implementors' class='anchor'></a>\
3103 <div class='item-list' id='synthetic-implementors-list'>\
3106 let mut synthetic_types = Vec::new();
3108 if let Some(implementors) = cache.implementors.get(&it.def_id) {
3109 // The DefId is for the first Type found with that name. The bool is
3110 // if any Types with the same name but different DefId have been found.
3111 let mut implementor_dups: FxHashMap<&str, (DefId, bool)> = FxHashMap::default();
3112 for implementor in implementors {
3113 match implementor.inner_impl().for_ {
3114 clean::ResolvedPath { ref path, did, is_generic: false, .. } |
3115 clean::BorrowedRef {
3116 type_: box clean::ResolvedPath { ref path, did, is_generic: false, .. },
3119 let &mut (prev_did, ref mut has_duplicates) =
3120 implementor_dups.entry(path.last_name()).or_insert((did, false));
3121 if prev_did != did {
3122 *has_duplicates = true;
3129 let (local, foreign) = implementors.iter()
3130 .partition::<Vec<_>, _>(|i| i.inner_impl().for_.def_id()
3131 .map_or(true, |d| cache.paths.contains_key(&d)));
3134 let (mut synthetic, mut concrete): (Vec<&&Impl>, Vec<&&Impl>) = local.iter()
3135 .partition(|i| i.inner_impl().synthetic);
3137 synthetic.sort_by(compare_impl);
3138 concrete.sort_by(compare_impl);
3140 if !foreign.is_empty() {
3142 <h2 id='foreign-impls' class='small-section-header'>
3143 Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
3147 for implementor in foreign {
3148 let assoc_link = AssocItemLink::GotoSource(
3149 implementor.impl_item.def_id,
3150 &implementor.inner_impl().provided_trait_methods
3152 render_impl(w, cx, &implementor, assoc_link,
3153 RenderMode::Normal, implementor.impl_item.stable_since(), false,
3158 write!(w, "{}", impl_header)?;
3159 for implementor in concrete {
3160 render_implementor(cx, implementor, w, &implementor_dups)?;
3162 write!(w, "</div>")?;
3165 write!(w, "{}", synthetic_impl_header)?;
3166 for implementor in synthetic {
3167 synthetic_types.extend(
3168 collect_paths_for_type(implementor.inner_impl().for_.clone())
3170 render_implementor(cx, implementor, w, &implementor_dups)?;
3172 write!(w, "</div>")?;
3175 // even without any implementations to write in, we still want the heading and list, so the
3176 // implementors javascript file pulled in below has somewhere to write the impls into
3177 write!(w, "{}", impl_header)?;
3178 write!(w, "</div>")?;
3181 write!(w, "{}", synthetic_impl_header)?;
3182 write!(w, "</div>")?;
3185 write!(w, r#"<script type="text/javascript">window.inlined_types=new Set({});</script>"#,
3186 as_json(&synthetic_types))?;
3188 write!(w, r#"<script type="text/javascript" async
3189 src="{root_path}/implementors/{path}/{ty}.{name}.js">
3191 root_path = vec![".."; cx.current.len()].join("/"),
3192 path = if it.def_id.is_local() {
3193 cx.current.join("/")
3195 let (ref path, _) = cache.external_paths[&it.def_id];
3196 path[..path.len() - 1].join("/")
3198 ty = it.type_().css_class(),
3199 name = *it.name.as_ref().unwrap())?;
3203 fn naive_assoc_href(it: &clean::Item, link: AssocItemLink) -> String {
3204 use html::item_type::ItemType::*;
3206 let name = it.name.as_ref().unwrap();
3207 let ty = match it.type_() {
3208 Typedef | AssociatedType => AssociatedType,
3212 let anchor = format!("#{}.{}", ty, name);
3214 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
3215 AssocItemLink::Anchor(None) => anchor,
3216 AssocItemLink::GotoSource(did, _) => {
3217 href(did).map(|p| format!("{}{}", p.0, anchor)).unwrap_or(anchor)
3222 fn assoc_const(w: &mut fmt::Formatter,
3225 _default: Option<&String>,
3226 link: AssocItemLink) -> fmt::Result {
3227 write!(w, "{}const <a href='{}' class=\"constant\"><b>{}</b></a>: {}",
3228 VisSpace(&it.visibility),
3229 naive_assoc_href(it, link),
3230 it.name.as_ref().unwrap(),
3235 fn assoc_type<W: fmt::Write>(w: &mut W, it: &clean::Item,
3236 bounds: &[clean::GenericBound],
3237 default: Option<&clean::Type>,
3238 link: AssocItemLink) -> fmt::Result {
3239 write!(w, "type <a href='{}' class=\"type\">{}</a>",
3240 naive_assoc_href(it, link),
3241 it.name.as_ref().unwrap())?;
3242 if !bounds.is_empty() {
3243 write!(w, ": {}", GenericBounds(bounds))?
3245 if let Some(default) = default {
3246 write!(w, " = {}", default)?;
3251 fn render_stability_since_raw<'a>(w: &mut fmt::Formatter,
3252 ver: Option<&'a str>,
3253 containing_ver: Option<&'a str>) -> fmt::Result {
3254 if let Some(v) = ver {
3255 if containing_ver != ver && v.len() > 0 {
3256 write!(w, "<div class='since' title='Stable since Rust version {0}'>{0}</div>",
3263 fn render_stability_since(w: &mut fmt::Formatter,
3265 containing_item: &clean::Item) -> fmt::Result {
3266 render_stability_since_raw(w, item.stable_since(), containing_item.stable_since())
3269 fn render_assoc_item(w: &mut fmt::Formatter,
3271 link: AssocItemLink,
3272 parent: ItemType) -> fmt::Result {
3273 fn method(w: &mut fmt::Formatter,
3275 header: hir::FnHeader,
3276 g: &clean::Generics,
3278 link: AssocItemLink,
3281 let name = meth.name.as_ref().unwrap();
3282 let anchor = format!("#{}.{}", meth.type_(), name);
3283 let href = match link {
3284 AssocItemLink::Anchor(Some(ref id)) => format!("#{}", id),
3285 AssocItemLink::Anchor(None) => anchor,
3286 AssocItemLink::GotoSource(did, provided_methods) => {
3287 // We're creating a link from an impl-item to the corresponding
3288 // trait-item and need to map the anchored type accordingly.
3289 let ty = if provided_methods.contains(name) {
3295 href(did).map(|p| format!("{}#{}.{}", p.0, ty, name)).unwrap_or(anchor)
3298 let mut head_len = format!("{}{}{}{}{:#}fn {}{:#}",
3299 VisSpace(&meth.visibility),
3300 ConstnessSpace(header.constness),
3301 UnsafetySpace(header.unsafety),
3302 AsyncSpace(header.asyncness),
3303 AbiSpace(header.abi),
3306 let (indent, end_newline) = if parent == ItemType::Trait {
3312 render_attributes(w, meth)?;
3313 write!(w, "{}{}{}{}{}fn <a href='{href}' class='fnname'>{name}</a>\
3314 {generics}{decl}{where_clause}",
3315 VisSpace(&meth.visibility),
3316 ConstnessSpace(header.constness),
3317 UnsafetySpace(header.unsafety),
3318 AsyncSpace(header.asyncness),
3319 AbiSpace(header.abi),
3328 where_clause = WhereClause {
3335 clean::StrippedItem(..) => Ok(()),
3336 clean::TyMethodItem(ref m) => {
3337 method(w, item, m.header, &m.generics, &m.decl, link, parent)
3339 clean::MethodItem(ref m) => {
3340 method(w, item, m.header, &m.generics, &m.decl, link, parent)
3342 clean::AssociatedConstItem(ref ty, ref default) => {
3343 assoc_const(w, item, ty, default.as_ref(), link)
3345 clean::AssociatedTypeItem(ref bounds, ref default) => {
3346 assoc_type(w, item, bounds, default.as_ref(), link)
3348 _ => panic!("render_assoc_item called on non-associated-item")
3352 fn item_struct(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3353 s: &clean::Struct) -> fmt::Result {
3354 wrap_into_docblock(w, |w| {
3355 write!(w, "<pre class='rust struct'>")?;
3356 render_attributes(w, it)?;
3367 document(w, cx, it)?;
3368 let mut fields = s.fields.iter().filter_map(|f| {
3370 clean::StructFieldItem(ref ty) => Some((f, ty)),
3374 if let doctree::Plain = s.struct_type {
3375 if fields.peek().is_some() {
3376 write!(w, "<h2 id='fields' class='fields small-section-header'>
3377 Fields{}<a href='#fields' class='anchor'></a></h2>",
3378 document_non_exhaustive_header(it))?;
3379 document_non_exhaustive(w, it)?;
3380 for (field, ty) in fields {
3381 let id = cx.derive_id(format!("{}.{}",
3382 ItemType::StructField,
3383 field.name.as_ref().unwrap()));
3384 let ns_id = cx.derive_id(format!("{}.{}",
3385 field.name.as_ref().unwrap(),
3386 ItemType::StructField.name_space()));
3387 write!(w, "<span id=\"{id}\" class=\"{item_type} small-section-header\">
3388 <a href=\"#{id}\" class=\"anchor field\"></a>
3389 <span id=\"{ns_id}\" class='invisible'>
3390 <code>{name}: {ty}</code>
3392 item_type = ItemType::StructField,
3395 name = field.name.as_ref().unwrap(),
3397 if let Some(stability_class) = field.stability_class() {
3398 write!(w, "<span class='stab {stab}'></span>",
3399 stab = stability_class)?;
3401 document(w, cx, field)?;
3405 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3408 fn item_union(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3409 s: &clean::Union) -> fmt::Result {
3410 wrap_into_docblock(w, |w| {
3411 write!(w, "<pre class='rust union'>")?;
3412 render_attributes(w, it)?;
3422 document(w, cx, it)?;
3423 let mut fields = s.fields.iter().filter_map(|f| {
3425 clean::StructFieldItem(ref ty) => Some((f, ty)),
3429 if fields.peek().is_some() {
3430 write!(w, "<h2 id='fields' class='fields small-section-header'>
3431 Fields<a href='#fields' class='anchor'></a></h2>")?;
3432 for (field, ty) in fields {
3433 let name = field.name.as_ref().expect("union field name");
3434 let id = format!("{}.{}", ItemType::StructField, name);
3435 write!(w, "<span id=\"{id}\" class=\"{shortty} small-section-header\">\
3436 <a href=\"#{id}\" class=\"anchor field\"></a>\
3437 <span class='invisible'><code>{name}: {ty}</code></span>\
3441 shortty = ItemType::StructField,
3443 if let Some(stability_class) = field.stability_class() {
3444 write!(w, "<span class='stab {stab}'></span>",
3445 stab = stability_class)?;
3447 document(w, cx, field)?;
3450 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
3453 fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
3454 e: &clean::Enum) -> fmt::Result {
3455 wrap_into_docblock(w, |w| {
3456 write!(w, "<pre class='rust enum'>")?;
3457 render_attributes(w, it)?;
3458 write!(w, "{}enum {}{}{}",
3459 VisSpace(&it.visibility),
3460 it.name.as_ref().unwrap(),
3462 WhereClause { gens: &e.generics, indent: 0, end_newline: true })?;
3463 if e.variants.is_empty() && !e.variants_stripped {
3464 write!(w, " {{}}")?;
3466 write!(w, " {{\n")?;
3467 for v in &e.variants {
3469 let name = v.name.as_ref().unwrap();
3471 clean::VariantItem(ref var) => {
3473 clean::VariantKind::CLike => write!(w, "{}", name)?,
3474 clean::VariantKind::Tuple(ref tys) => {
3475 write!(w, "{}(", name)?;
3476 for (i, ty) in tys.iter().enumerate() {
3478 write!(w, ", ")?
3480 write!(w, "{}", *ty)?;
3484 clean::VariantKind::Struct(ref s) => {
3500 if e.variants_stripped {
3501 write!(w, " // some variants omitted\n")?;
3508 document(w, cx, it)?;
3509 if !e.variants.is_empty() {
3510 write!(w, "<h2 id='variants' class='variants small-section-header'>
3511 Variants{}<a href='#variants' class='anchor'></a></h2>\n",
3512 document_non_exhaustive_header(it))?;
3513 document_non_exhaustive(w, it)?;
3514 for variant in &e.variants {
3515 let id = cx.derive_id(format!("{}.{}",
3517 variant.name.as_ref().unwrap()));
3518 let ns_id = cx.derive_id(format!("{}.{}",
3519 variant.name.as_ref().unwrap(),
3520 ItemType::Variant.name_space()));
3521 write!(w, "<span id=\"{id}\" class=\"variant small-section-header\">\
3522 <a href=\"#{id}\" class=\"anchor field\"></a>\
3523 <span id='{ns_id}' class='invisible'><code>{name}",
3526 name = variant.name.as_ref().unwrap())?;
3527 if let clean::VariantItem(ref var) = variant.inner {
3528 if let clean::VariantKind::Tuple(ref tys) = var.kind {
3530 for (i, ty) in tys.iter().enumerate() {
3532 write!(w, ", ")?;
3534 write!(w, "{}", *ty)?;
3539 write!(w, "</code></span></span>")?;
3540 document(w, cx, variant)?;
3542 use clean::{Variant, VariantKind};
3543 if let clean::VariantItem(Variant {
3544 kind: VariantKind::Struct(ref s)
3545 }) = variant.inner {
3546 let variant_id = cx.derive_id(format!("{}.{}.fields",
3548 variant.name.as_ref().unwrap()));
3549 write!(w, "<span class='autohide sub-variant' id='{id}'>",
3551 write!(w, "<h3>Fields of <b>{name}</b></h3><div>",
3552 name = variant.name.as_ref().unwrap())?;
3553 for field in &s.fields {
3554 use clean::StructFieldItem;
3555 if let StructFieldItem(ref ty) = field.inner {
3556 let id = cx.derive_id(format!("variant.{}.field.{}",
3557 variant.name.as_ref().unwrap(),
3558 field.name.as_ref().unwrap()));
3559 let ns_id = cx.derive_id(format!("{}.{}.{}.{}",
3560 variant.name.as_ref().unwrap(),
3561 ItemType::Variant.name_space(),
3562 field.name.as_ref().unwrap(),
3563 ItemType::StructField.name_space()));
3564 write!(w, "<span id=\"{id}\" class=\"variant small-section-header\">\
3565 <a href=\"#{id}\" class=\"anchor field\"></a>\
3566 <span id='{ns_id}' class='invisible'><code>{f}: {t}\
3567 </code></span></span>",
3570 f = field.name.as_ref().unwrap(),
3572 document(w, cx, field)?;
3575 write!(w, "</div></span>")?;
3577 render_stability_since(w, variant, it)?;
3580 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)?;
3584 fn render_attribute(attr: &ast::MetaItem) -> Option<String> {
3585 let name = attr.name();
3588 Some(name.to_string())
3589 } else if let Some(v) = attr.value_str() {
3590 Some(format!("{} = {:?}", name, v.as_str()))
3591 } else if let Some(values) = attr.meta_item_list() {
3592 let display: Vec<_> = values.iter().filter_map(|attr| {
3593 attr.meta_item().and_then(|mi| render_attribute(mi))
3596 if display.len() > 0 {
3597 Some(format!("{}({})", name, display.join(", ")))
3606 const ATTRIBUTE_WHITELIST: &'static [&'static str] = &[
3613 "unsafe_destructor_blind_to_params",
3617 fn render_attributes(w: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
3618 let mut attrs = String::new();
3620 for attr in &it.attrs.other_attrs {
3621 let name = attr.name();
3622 if !ATTRIBUTE_WHITELIST.contains(&&*name.as_str()) {
3625 if let Some(s) = render_attribute(&attr.meta().unwrap()) {
3626 attrs.push_str(&format!("#[{}]\n", s));
3629 if attrs.len() > 0 {
3630 write!(w, "<div class=\"docblock attributes\">{}</div>", &attrs)?;
3635 fn render_struct(w: &mut fmt::Formatter, it: &clean::Item,
3636 g: Option<&clean::Generics>,
3637 ty: doctree::StructType,
3638 fields: &[clean::Item],
3640 structhead: bool) -> fmt::Result {
3642 VisSpace(&it.visibility),
3643 if structhead {"struct "} else {""},
3644 it.name.as_ref().unwrap())?;
3645 if let Some(g) = g {
3650 if let Some(g) = g {
3651 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?
3653 let mut has_visible_fields = false;
3655 for field in fields {
3656 if let clean::StructFieldItem(ref ty) = field.inner {
3657 write!(w, "\n{} {}{}: {},",
3659 VisSpace(&field.visibility),
3660 field.name.as_ref().unwrap(),
3662 has_visible_fields = true;
3666 if has_visible_fields {
3667 if it.has_stripped_fields().unwrap() {
3668 write!(w, "\n{} // some fields omitted", tab)?;
3670 write!(w, "\n{}", tab)?;
3671 } else if it.has_stripped_fields().unwrap() {
3672 // If there are no visible fields we can just display
3673 // `{ /* fields omitted */ }` to save space.
3674 write!(w, " /* fields omitted */ ")?;
3680 for (i, field) in fields.iter().enumerate() {
3685 clean::StrippedItem(box clean::StructFieldItem(..)) => {
3688 clean::StructFieldItem(ref ty) => {
3689 write!(w, "{}{}", VisSpace(&field.visibility), *ty)?
3695 if let Some(g) = g {
3696 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
3701 // Needed for PhantomData.
3702 if let Some(g) = g {
3703 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: false })?
3711 fn render_union(w: &mut fmt::Formatter, it: &clean::Item,
3712 g: Option<&clean::Generics>,
3713 fields: &[clean::Item],
3715 structhead: bool) -> fmt::Result {
3717 VisSpace(&it.visibility),
3718 if structhead {"union "} else {""},
3719 it.name.as_ref().unwrap())?;
3720 if let Some(g) = g {
3721 write!(w, "{}", g)?;
3722 write!(w, "{}", WhereClause { gens: g, indent: 0, end_newline: true })?;
3725 write!(w, " {{\n{}", tab)?;
3726 for field in fields {
3727 if let clean::StructFieldItem(ref ty) = field.inner {
3728 write!(w, " {}{}: {},\n{}",
3729 VisSpace(&field.visibility),
3730 field.name.as_ref().unwrap(),
3736 if it.has_stripped_fields().unwrap() {
3737 write!(w, " // some fields omitted\n{}", tab)?;
3743 #[derive(Copy, Clone)]
3744 enum AssocItemLink<'a> {
3745 Anchor(Option<&'a str>),
3746 GotoSource(DefId, &'a FxHashSet<String>),
3749 impl<'a> AssocItemLink<'a> {
3750 fn anchor(&self, id: &'a String) -> Self {
3752 AssocItemLink::Anchor(_) => { AssocItemLink::Anchor(Some(&id)) },
3753 ref other => *other,
3758 enum AssocItemRender<'a> {
3760 DerefFor { trait_: &'a clean::Type, type_: &'a clean::Type, deref_mut_: bool }
3763 #[derive(Copy, Clone, PartialEq)]
3766 ForDeref { mut_: bool },
3769 fn render_assoc_items(w: &mut fmt::Formatter,
3771 containing_item: &clean::Item,
3773 what: AssocItemRender) -> fmt::Result {
3775 let v = match c.impls.get(&it) {
3777 None => return Ok(()),
3779 let (non_trait, traits): (Vec<_>, _) = v.iter().partition(|i| {
3780 i.inner_impl().trait_.is_none()
3782 if !non_trait.is_empty() {
3783 let render_mode = match what {
3784 AssocItemRender::All => {
3786 <h2 id='methods' class='small-section-header'>\
3787 Methods<a href='#methods' class='anchor'></a>\
3792 AssocItemRender::DerefFor { trait_, type_, deref_mut_ } => {
3794 <h2 id='deref-methods' class='small-section-header'>\
3795 Methods from {}<Target = {}>\
3796 <a href='#deref-methods' class='anchor'></a>\
3799 RenderMode::ForDeref { mut_: deref_mut_ }
3802 for i in &non_trait {
3803 render_impl(w, cx, i, AssocItemLink::Anchor(None), render_mode,
3804 containing_item.stable_since(), true, None)?;
3807 if let AssocItemRender::DerefFor { .. } = what {
3810 if !traits.is_empty() {
3811 let deref_impl = traits.iter().find(|t| {
3812 t.inner_impl().trait_.def_id() == c.deref_trait_did
3814 if let Some(impl_) = deref_impl {
3815 let has_deref_mut = traits.iter().find(|t| {
3816 t.inner_impl().trait_.def_id() == c.deref_mut_trait_did
3818 render_deref_methods(w, cx, impl_, containing_item, has_deref_mut)?;
3821 let (synthetic, concrete): (Vec<&&Impl>, Vec<&&Impl>) = traits
3823 .partition(|t| t.inner_impl().synthetic);
3824 let (blanket_impl, concrete) = concrete
3826 .partition(|t| t.inner_impl().blanket_impl.is_some());
3828 struct RendererStruct<'a, 'b, 'c>(&'a Context, Vec<&'b &'b Impl>, &'c clean::Item);
3830 impl<'a, 'b, 'c> fmt::Display for RendererStruct<'a, 'b, 'c> {
3831 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
3832 render_impls(self.0, fmt, &self.1, self.2)
3836 let impls = RendererStruct(cx, concrete, containing_item).to_string();
3837 if !impls.is_empty() {
3839 <h2 id='implementations' class='small-section-header'>\
3840 Trait Implementations<a href='#implementations' class='anchor'></a>\
3842 <div id='implementations-list'>{}</div>", impls)?;
3845 if !synthetic.is_empty() {
3847 <h2 id='synthetic-implementations' class='small-section-header'>\
3848 Auto Trait Implementations\
3849 <a href='#synthetic-implementations' class='anchor'></a>\
3851 <div id='synthetic-implementations-list'>\
3853 render_impls(cx, w, &synthetic, containing_item)?;
3854 write!(w, "</div>")?;
3857 if !blanket_impl.is_empty() {
3859 <h2 id='blanket-implementations' class='small-section-header'>\
3860 Blanket Implementations\
3861 <a href='#blanket-implementations' class='anchor'></a>\
3863 <div id='blanket-implementations-list'>\
3865 render_impls(cx, w, &blanket_impl, containing_item)?;
3866 write!(w, "</div>")?;
3872 fn render_deref_methods(w: &mut fmt::Formatter, cx: &Context, impl_: &Impl,
3873 container_item: &clean::Item, deref_mut: bool) -> fmt::Result {
3874 let deref_type = impl_.inner_impl().trait_.as_ref().unwrap();
3875 let target = impl_.inner_impl().items.iter().filter_map(|item| {
3877 clean::TypedefItem(ref t, true) => Some(&t.type_),
3880 }).next().expect("Expected associated type binding");
3881 let what = AssocItemRender::DerefFor { trait_: deref_type, type_: target,
3882 deref_mut_: deref_mut };
3883 if let Some(did) = target.def_id() {
3884 render_assoc_items(w, cx, container_item, did, what)
3886 if let Some(prim) = target.primitive_type() {
3887 if let Some(&did) = cache().primitive_locations.get(&prim) {
3888 render_assoc_items(w, cx, container_item, did, what)?;
3895 fn should_render_item(item: &clean::Item, deref_mut_: bool) -> bool {
3896 let self_type_opt = match item.inner {
3897 clean::MethodItem(ref method) => method.decl.self_type(),
3898 clean::TyMethodItem(ref method) => method.decl.self_type(),
3902 if let Some(self_ty) = self_type_opt {
3903 let (by_mut_ref, by_box, by_value) = match self_ty {
3904 SelfTy::SelfBorrowed(_, mutability) |
3905 SelfTy::SelfExplicit(clean::BorrowedRef { mutability, .. }) => {
3906 (mutability == Mutability::Mutable, false, false)
3908 SelfTy::SelfExplicit(clean::ResolvedPath { did, .. }) => {
3909 (false, Some(did) == cache().owned_box_did, false)
3911 SelfTy::SelfValue => (false, false, true),
3912 _ => (false, false, false),
3915 (deref_mut_ || !by_mut_ref) && !by_box && !by_value
3921 fn render_spotlight_traits(item: &clean::Item) -> Result<String, fmt::Error> {
3922 let mut out = String::new();
3925 clean::FunctionItem(clean::Function { ref decl, .. }) |
3926 clean::TyMethodItem(clean::TyMethod { ref decl, .. }) |
3927 clean::MethodItem(clean::Method { ref decl, .. }) |
3928 clean::ForeignFunctionItem(clean::Function { ref decl, .. }) => {
3929 out = spotlight_decl(decl)?;
3937 fn spotlight_decl(decl: &clean::FnDecl) -> Result<String, fmt::Error> {
3938 let mut out = String::new();
3939 let mut trait_ = String::new();
3941 if let Some(did) = decl.output.def_id() {
3943 if let Some(impls) = c.impls.get(&did) {
3945 let impl_ = i.inner_impl();
3946 if impl_.trait_.def_id().map_or(false, |d| c.traits[&d].is_spotlight) {
3949 &format!("<h3 class=\"important\">Important traits for {}</h3>\
3950 <code class=\"content\">",
3952 trait_.push_str(&impl_.for_.to_string());
3955 //use the "where" class here to make it small
3956 out.push_str(&format!("<span class=\"where fmt-newline\">{}</span>", impl_));
3957 let t_did = impl_.trait_.def_id().unwrap();
3958 for it in &impl_.items {
3959 if let clean::TypedefItem(ref tydef, _) = it.inner {
3960 out.push_str("<span class=\"where fmt-newline\"> ");
3961 assoc_type(&mut out, it, &[],
3963 AssocItemLink::GotoSource(t_did, &FxHashSet::default()))?;
3964 out.push_str(";</span>");
3972 if !out.is_empty() {
3973 out.insert_str(0, &format!("<div class=\"important-traits\"><div class='tooltip'>ⓘ\
3974 <span class='tooltiptext'>Important traits for {}</span></div>\
3975 <div class=\"content hidden\">",
3977 out.push_str("</code></div></div>");
3983 fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLink,
3984 render_mode: RenderMode, outer_version: Option<&str>,
3985 show_def_docs: bool, use_absolute: Option<bool>) -> fmt::Result {
3986 if render_mode == RenderMode::Normal {
3987 let id = cx.derive_id(match i.inner_impl().trait_ {
3988 Some(ref t) => format!("impl-{}", small_url_encode(&format!("{:#}", t))),
3989 None => "impl".to_string(),
3991 if let Some(use_absolute) = use_absolute {
3992 write!(w, "<h3 id='{}' class='impl'><span class='in-band'><table class='table-display'>\
3993 <tbody><tr><td><code>", id)?;
3994 fmt_impl_for_trait_page(&i.inner_impl(), w, use_absolute)?;
3996 for it in &i.inner_impl().items {
3997 if let clean::TypedefItem(ref tydef, _) = it.inner {
3998 write!(w, "<span class=\"where fmt-newline\"> ")?;
3999 assoc_type(w, it, &vec![], Some(&tydef.type_),
4000 AssocItemLink::Anchor(None))?;
4001 write!(w, ";</span>")?;
4005 write!(w, "</code>")?;
4007 write!(w, "<h3 id='{}' class='impl'><span class='in-band'><table class='table-display'>\
4008 <tbody><tr><td><code>{}</code>",
4009 id, i.inner_impl())?;
4011 write!(w, "<a href='#{}' class='anchor'></a>", id)?;
4012 write!(w, "</span></td><td><span class='out-of-band'>")?;
4013 let since = i.impl_item.stability.as_ref().map(|s| &s.since[..]);
4014 if let Some(l) = (Item { item: &i.impl_item, cx: cx }).src_href() {
4015 write!(w, "<div class='ghost'></div>")?;
4016 render_stability_since_raw(w, since, outer_version)?;
4017 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
4018 l, "goto source code")?;
4020 render_stability_since_raw(w, since, outer_version)?;
4022 write!(w, "</span></td></tr></tbody></table></h3>")?;
4023 if let Some(ref dox) = cx.shared.maybe_collapsed_doc_value(&i.impl_item) {
4024 let mut ids = cx.id_map.borrow_mut();
4025 write!(w, "<div class='docblock'>{}</div>",
4026 Markdown(&*dox, &i.impl_item.links(), RefCell::new(&mut ids), cx.codes))?;
4030 fn doc_impl_item(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
4031 link: AssocItemLink, render_mode: RenderMode,
4032 is_default_item: bool, outer_version: Option<&str>,
4033 trait_: Option<&clean::Trait>, show_def_docs: bool) -> fmt::Result {
4034 let item_type = item.type_();
4035 let name = item.name.as_ref().unwrap();
4037 let render_method_item: bool = match render_mode {
4038 RenderMode::Normal => true,
4039 RenderMode::ForDeref { mut_: deref_mut_ } => should_render_item(&item, deref_mut_),
4042 let (is_hidden, extra_class) = if trait_.is_none() ||
4043 item.doc_value().is_some() ||
4044 item.inner.is_associated() {
4050 clean::MethodItem(clean::Method { ref decl, .. }) |
4051 clean::TyMethodItem(clean::TyMethod { ref decl, .. }) => {
4052 // Only render when the method is not static or we allow static methods
4053 if render_method_item {
4054 let id = cx.derive_id(format!("{}.{}", item_type, name));
4055 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
4056 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class)?;
4057 write!(w, "{}", spotlight_decl(decl)?)?;
4058 write!(w, "<span id='{}' class='invisible'>", ns_id)?;
4059 write!(w, "<table class='table-display'><tbody><tr><td><code>")?;
4060 render_assoc_item(w, item, link.anchor(&id), ItemType::Impl)?;
4061 write!(w, "</code>")?;
4062 if let Some(l) = (Item { cx, item }).src_href() {
4063 write!(w, "</span></td><td><span class='out-of-band'>")?;
4064 write!(w, "<div class='ghost'></div>")?;
4065 render_stability_since_raw(w, item.stable_since(), outer_version)?;
4066 write!(w, "<a class='srclink' href='{}' title='{}'>[src]</a>",
4067 l, "goto source code")?;
4069 write!(w, "</td><td>")?;
4070 render_stability_since_raw(w, item.stable_since(), outer_version)?;
4072 write!(w, "</td></tr></tbody></table></span></h4>")?;
4075 clean::TypedefItem(ref tydef, _) => {
4076 let id = cx.derive_id(format!("{}.{}", ItemType::AssociatedType, name));
4077 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
4078 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class)?;
4079 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
4080 assoc_type(w, item, &Vec::new(), Some(&tydef.type_), link.anchor(&id))?;
4081 write!(w, "</code></span></h4>\n")?;
4083 clean::AssociatedConstItem(ref ty, ref default) => {
4084 let id = cx.derive_id(format!("{}.{}", item_type, name));
4085 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
4086 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class)?;
4087 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
4088 assoc_const(w, item, ty, default.as_ref(), link.anchor(&id))?;
4089 let src = if let Some(l) = (Item { cx, item }).src_href() {
4090 format!("<a class='srclink' href='{}' title='{}'>[src]</a>",
4091 l, "goto source code")
4095 write!(w, "</code>{}</span></h4>\n", src)?;
4097 clean::AssociatedTypeItem(ref bounds, ref default) => {
4098 let id = cx.derive_id(format!("{}.{}", item_type, name));
4099 let ns_id = cx.derive_id(format!("{}.{}", name, item_type.name_space()));
4100 write!(w, "<h4 id='{}' class=\"{}{}\">", id, item_type, extra_class)?;
4101 write!(w, "<span id='{}' class='invisible'><code>", ns_id)?;
4102 assoc_type(w, item, bounds, default.as_ref(), link.anchor(&id))?;
4103 write!(w, "</code></span></h4>\n")?;
4105 clean::StrippedItem(..) => return Ok(()),
4106 _ => panic!("can't make docs for trait item with name {:?}", item.name)
4109 if render_method_item || render_mode == RenderMode::Normal {
4110 if !is_default_item {
4111 if let Some(t) = trait_ {
4112 // The trait item may have been stripped so we might not
4113 // find any documentation or stability for it.
4114 if let Some(it) = t.items.iter().find(|i| i.name == item.name) {
4115 // We need the stability of the item from the trait
4116 // because impls can't have a stability.
4117 document_stability(w, cx, it, is_hidden)?;
4118 if item.doc_value().is_some() {
4119 document_full(w, item, cx, "", is_hidden)?;
4120 } else if show_def_docs {
4121 // In case the item isn't documented,
4122 // provide short documentation from the trait.
4123 document_short(w, cx, it, link, "", is_hidden)?;
4127 document_stability(w, cx, item, is_hidden)?;
4129 document_full(w, item, cx, "", is_hidden)?;
4133 document_stability(w, cx, item, is_hidden)?;
4135 document_short(w, cx, item, link, "", is_hidden)?;
4142 let traits = &cache().traits;
4143 let trait_ = i.trait_did().map(|did| &traits[&did]);
4145 write!(w, "<div class='impl-items'>")?;
4146 for trait_item in &i.inner_impl().items {
4147 doc_impl_item(w, cx, trait_item, link, render_mode,
4148 false, outer_version, trait_, show_def_docs)?;
4151 fn render_default_items(w: &mut fmt::Formatter,
4155 render_mode: RenderMode,
4156 outer_version: Option<&str>,
4157 show_def_docs: bool) -> fmt::Result {
4158 for trait_item in &t.items {
4159 let n = trait_item.name.clone();
4160 if i.items.iter().find(|m| m.name == n).is_some() {
4163 let did = i.trait_.as_ref().unwrap().def_id().unwrap();
4164 let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
4166 doc_impl_item(w, cx, trait_item, assoc_link, render_mode, true,
4167 outer_version, None, show_def_docs)?;
4172 // If we've implemented a trait, then also emit documentation for all
4173 // default items which weren't overridden in the implementation block.
4174 if let Some(t) = trait_ {
4175 render_default_items(w, cx, t, &i.inner_impl(),
4176 render_mode, outer_version, show_def_docs)?;
4178 write!(w, "</div>")?;
4183 fn item_existential(
4184 w: &mut fmt::Formatter,
4187 t: &clean::Existential,
4189 write!(w, "<pre class='rust existential'>")?;
4190 render_attributes(w, it)?;
4191 write!(w, "existential type {}{}{where_clause}: {bounds};</pre>",
4192 it.name.as_ref().unwrap(),
4194 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
4195 bounds = bounds(&t.bounds))?;
4197 document(w, cx, it)?;
4199 // Render any items associated directly to this alias, as otherwise they
4200 // won't be visible anywhere in the docs. It would be nice to also show
4201 // associated items from the aliased type (see discussion in #32077), but
4202 // we need #14072 to make sense of the generics.
4203 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4206 fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
4207 t: &clean::Typedef) -> fmt::Result {
4208 write!(w, "<pre class='rust typedef'>")?;
4209 render_attributes(w, it)?;
4210 write!(w, "type {}{}{where_clause} = {type_};</pre>",
4211 it.name.as_ref().unwrap(),
4213 where_clause = WhereClause { gens: &t.generics, indent: 0, end_newline: true },
4216 document(w, cx, it)?;
4218 // Render any items associated directly to this alias, as otherwise they
4219 // won't be visible anywhere in the docs. It would be nice to also show
4220 // associated items from the aliased type (see discussion in #32077), but
4221 // we need #14072 to make sense of the generics.
4222 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4225 fn item_foreign_type(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item) -> fmt::Result {
4226 writeln!(w, "<pre class='rust foreigntype'>extern {{")?;
4227 render_attributes(w, it)?;
4230 " {}type {};\n}}</pre>",
4231 VisSpace(&it.visibility),
4232 it.name.as_ref().unwrap(),
4235 document(w, cx, it)?;
4237 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4240 impl<'a> fmt::Display for Sidebar<'a> {
4241 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
4244 let parentlen = cx.current.len() - if it.is_mod() {1} else {0};
4246 if it.is_struct() || it.is_trait() || it.is_primitive() || it.is_union()
4247 || it.is_enum() || it.is_mod() || it.is_typedef() {
4248 write!(fmt, "<p class='location'>{}{}</p>",
4250 clean::StructItem(..) => "Struct ",
4251 clean::TraitItem(..) => "Trait ",
4252 clean::PrimitiveItem(..) => "Primitive Type ",
4253 clean::UnionItem(..) => "Union ",
4254 clean::EnumItem(..) => "Enum ",
4255 clean::TypedefItem(..) => "Type Definition ",
4256 clean::ForeignTypeItem => "Foreign Type ",
4257 clean::ModuleItem(..) => if it.is_crate() {
4264 it.name.as_ref().unwrap())?;
4268 if let Some(ref version) = cache().crate_version {
4270 "<div class='block version'>\
4277 write!(fmt, "<div class=\"sidebar-elems\">")?;
4279 write!(fmt, "<a id='all-types' href='all.html'><p>See all {}'s items</p></a>",
4280 it.name.as_ref().expect("crates always have a name"))?;
4283 clean::StructItem(ref s) => sidebar_struct(fmt, it, s)?,
4284 clean::TraitItem(ref t) => sidebar_trait(fmt, it, t)?,
4285 clean::PrimitiveItem(ref p) => sidebar_primitive(fmt, it, p)?,
4286 clean::UnionItem(ref u) => sidebar_union(fmt, it, u)?,
4287 clean::EnumItem(ref e) => sidebar_enum(fmt, it, e)?,
4288 clean::TypedefItem(ref t, _) => sidebar_typedef(fmt, it, t)?,
4289 clean::ModuleItem(ref m) => sidebar_module(fmt, it, &m.items)?,
4290 clean::ForeignTypeItem => sidebar_foreign_type(fmt, it)?,
4294 // The sidebar is designed to display sibling functions, modules and
4295 // other miscellaneous information. since there are lots of sibling
4296 // items (and that causes quadratic growth in large modules),
4297 // we refactor common parts into a shared JavaScript file per module.
4298 // still, we don't move everything into JS because we want to preserve
4299 // as much HTML as possible in order to allow non-JS-enabled browsers
4300 // to navigate the documentation (though slightly inefficiently).
4302 write!(fmt, "<p class='location'>")?;
4303 for (i, name) in cx.current.iter().take(parentlen).enumerate() {
4305 write!(fmt, "::<wbr>")?;
4307 write!(fmt, "<a href='{}index.html'>{}</a>",
4308 &cx.root_path()[..(cx.current.len() - i - 1) * 3],
4311 write!(fmt, "</p>")?;
4313 // Sidebar refers to the enclosing module, not this module.
4314 let relpath = if it.is_mod() { "../" } else { "" };
4316 "<script>window.sidebarCurrent = {{\
4321 name = it.name.as_ref().map(|x| &x[..]).unwrap_or(""),
4322 ty = it.type_().css_class(),
4325 // There is no sidebar-items.js beyond the crate root path
4326 // FIXME maybe dynamic crate loading can be merged here
4328 write!(fmt, "<script defer src=\"{path}sidebar-items.js\"></script>",
4331 // Closes sidebar-elems div.
4332 write!(fmt, "</div>")?;
4338 fn get_next_url(used_links: &mut FxHashSet<String>, url: String) -> String {
4339 if used_links.insert(url.clone()) {
4343 while used_links.insert(format!("{}-{}", url, add)) == false {
4346 format!("{}-{}", url, add)
4352 used_links: &mut FxHashSet<String>,
4354 i.items.iter().filter_map(|item| {
4356 // Maybe check with clean::Visibility::Public as well?
4357 Some(ref name) if !name.is_empty() && item.visibility.is_some() && item.is_method() => {
4358 if !for_deref || should_render_item(item, false) {
4359 Some(format!("<a href=\"#{}\">{}</a>",
4360 get_next_url(used_links, format!("method.{}", name)),
4368 }).collect::<Vec<_>>()
4371 // The point is to url encode any potential character from a type with genericity.
4372 fn small_url_encode(s: &str) -> String {
4373 s.replace("<", "%3C")
4374 .replace(">", "%3E")
4375 .replace(" ", "%20")
4376 .replace("?", "%3F")
4377 .replace("'", "%27")
4378 .replace("&", "%26")
4379 .replace(",", "%2C")
4380 .replace(":", "%3A")
4381 .replace(";", "%3B")
4382 .replace("[", "%5B")
4383 .replace("]", "%5D")
4384 .replace("\"", "%22")
4387 fn sidebar_assoc_items(it: &clean::Item) -> String {
4388 let mut out = String::new();
4390 if let Some(v) = c.impls.get(&it.def_id) {
4391 let mut used_links = FxHashSet::default();
4394 let used_links_bor = Rc::new(RefCell::new(&mut used_links));
4396 .filter(|i| i.inner_impl().trait_.is_none())
4397 .flat_map(move |i| get_methods(i.inner_impl(),
4399 &mut used_links_bor.borrow_mut()))
4400 .collect::<String>();
4401 if !ret.is_empty() {
4402 out.push_str(&format!("<a class=\"sidebar-title\" href=\"#methods\">Methods\
4403 </a><div class=\"sidebar-links\">{}</div>", ret));
4407 if v.iter().any(|i| i.inner_impl().trait_.is_some()) {
4408 if let Some(impl_) = v.iter()
4409 .filter(|i| i.inner_impl().trait_.is_some())
4410 .find(|i| i.inner_impl().trait_.def_id() == c.deref_trait_did) {
4411 if let Some(target) = impl_.inner_impl().items.iter().filter_map(|item| {
4413 clean::TypedefItem(ref t, true) => Some(&t.type_),
4417 let inner_impl = target.def_id().or(target.primitive_type().and_then(|prim| {
4418 c.primitive_locations.get(&prim).cloned()
4419 })).and_then(|did| c.impls.get(&did));
4420 if let Some(impls) = inner_impl {
4421 out.push_str("<a class=\"sidebar-title\" href=\"#deref-methods\">");
4422 out.push_str(&format!("Methods from {}<Target={}>",
4423 Escape(&format!("{:#}",
4424 impl_.inner_impl().trait_.as_ref().unwrap())),
4425 Escape(&format!("{:#}", target))));
4426 out.push_str("</a>");
4427 let ret = impls.iter()
4428 .filter(|i| i.inner_impl().trait_.is_none())
4429 .flat_map(|i| get_methods(i.inner_impl(),
4432 .collect::<String>();
4433 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", ret));
4437 let format_impls = |impls: Vec<&Impl>| {
4438 let mut links = FxHashSet::default();
4442 let is_negative_impl = is_negative_impl(i.inner_impl());
4443 if let Some(ref i) = i.inner_impl().trait_ {
4444 let i_display = format!("{:#}", i);
4445 let out = Escape(&i_display);
4446 let encoded = small_url_encode(&format!("{:#}", i));
4447 let generated = format!("<a href=\"#impl-{}\">{}{}</a>",
4449 if is_negative_impl { "!" } else { "" },
4451 if links.insert(generated.clone()) {
4460 .collect::<String>()
4463 let (synthetic, concrete): (Vec<&Impl>, Vec<&Impl>) = v
4465 .partition::<Vec<_>, _>(|i| i.inner_impl().synthetic);
4466 let (blanket_impl, concrete): (Vec<&Impl>, Vec<&Impl>) = concrete
4468 .partition::<Vec<_>, _>(|i| i.inner_impl().blanket_impl.is_some());
4470 let concrete_format = format_impls(concrete);
4471 let synthetic_format = format_impls(synthetic);
4472 let blanket_format = format_impls(blanket_impl);
4474 if !concrete_format.is_empty() {
4475 out.push_str("<a class=\"sidebar-title\" href=\"#implementations\">\
4476 Trait Implementations</a>");
4477 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", concrete_format));
4480 if !synthetic_format.is_empty() {
4481 out.push_str("<a class=\"sidebar-title\" href=\"#synthetic-implementations\">\
4482 Auto Trait Implementations</a>");
4483 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", synthetic_format));
4486 if !blanket_format.is_empty() {
4487 out.push_str("<a class=\"sidebar-title\" href=\"#blanket-implementations\">\
4488 Blanket Implementations</a>");
4489 out.push_str(&format!("<div class=\"sidebar-links\">{}</div>", blanket_format));
4497 fn sidebar_struct(fmt: &mut fmt::Formatter, it: &clean::Item,
4498 s: &clean::Struct) -> fmt::Result {
4499 let mut sidebar = String::new();
4500 let fields = get_struct_fields_name(&s.fields);
4502 if !fields.is_empty() {
4503 if let doctree::Plain = s.struct_type {
4504 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4505 <div class=\"sidebar-links\">{}</div>", fields));
4509 sidebar.push_str(&sidebar_assoc_items(it));
4511 if !sidebar.is_empty() {
4512 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4517 fn extract_for_impl_name(item: &clean::Item) -> Option<(String, String)> {
4519 clean::ItemEnum::ImplItem(ref i) => {
4520 if let Some(ref trait_) = i.trait_ {
4521 Some((format!("{:#}", i.for_), format!("{:#}", trait_)))
4530 fn is_negative_impl(i: &clean::Impl) -> bool {
4531 i.polarity == Some(clean::ImplPolarity::Negative)
4534 fn sidebar_trait(fmt: &mut fmt::Formatter, it: &clean::Item,
4535 t: &clean::Trait) -> fmt::Result {
4536 let mut sidebar = String::new();
4542 Some(ref name) if m.is_associated_type() => {
4543 Some(format!("<a href=\"#associatedtype.{name}\">{name}</a>",
4549 .collect::<String>();
4550 let consts = t.items
4554 Some(ref name) if m.is_associated_const() => {
4555 Some(format!("<a href=\"#associatedconstant.{name}\">{name}</a>",
4561 .collect::<String>();
4562 let required = t.items
4566 Some(ref name) if m.is_ty_method() => {
4567 Some(format!("<a href=\"#tymethod.{name}\">{name}</a>",
4573 .collect::<String>();
4574 let provided = t.items
4578 Some(ref name) if m.is_method() => {
4579 Some(format!("<a href=\"#method.{name}\">{name}</a>", name=name))
4584 .collect::<String>();
4586 if !types.is_empty() {
4587 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#associated-types\">\
4588 Associated Types</a><div class=\"sidebar-links\">{}</div>",
4591 if !consts.is_empty() {
4592 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#associated-const\">\
4593 Associated Constants</a><div class=\"sidebar-links\">{}</div>",
4596 if !required.is_empty() {
4597 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#required-methods\">\
4598 Required Methods</a><div class=\"sidebar-links\">{}</div>",
4601 if !provided.is_empty() {
4602 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#provided-methods\">\
4603 Provided Methods</a><div class=\"sidebar-links\">{}</div>",
4609 if let Some(implementors) = c.implementors.get(&it.def_id) {
4610 let res = implementors.iter()
4611 .filter(|i| i.inner_impl().for_.def_id()
4612 .map_or(false, |d| !c.paths.contains_key(&d)))
4614 match extract_for_impl_name(&i.impl_item) {
4615 Some((ref name, ref url)) => {
4616 Some(format!("<a href=\"#impl-{}\">{}</a>",
4617 small_url_encode(url),
4623 .collect::<String>();
4624 if !res.is_empty() {
4625 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#foreign-impls\">\
4626 Implementations on Foreign Types</a><div \
4627 class=\"sidebar-links\">{}</div>",
4632 sidebar.push_str("<a class=\"sidebar-title\" href=\"#implementors\">Implementors</a>");
4634 sidebar.push_str("<a class=\"sidebar-title\" \
4635 href=\"#synthetic-implementors\">Auto Implementors</a>");
4638 sidebar.push_str(&sidebar_assoc_items(it));
4640 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)
4643 fn sidebar_primitive(fmt: &mut fmt::Formatter, it: &clean::Item,
4644 _p: &clean::PrimitiveType) -> fmt::Result {
4645 let sidebar = sidebar_assoc_items(it);
4647 if !sidebar.is_empty() {
4648 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4653 fn sidebar_typedef(fmt: &mut fmt::Formatter, it: &clean::Item,
4654 _t: &clean::Typedef) -> fmt::Result {
4655 let sidebar = sidebar_assoc_items(it);
4657 if !sidebar.is_empty() {
4658 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4663 fn get_struct_fields_name(fields: &[clean::Item]) -> String {
4665 .filter(|f| if let clean::StructFieldItem(..) = f.inner {
4670 .filter_map(|f| match f.name {
4671 Some(ref name) => Some(format!("<a href=\"#structfield.{name}\">\
4672 {name}</a>", name=name)),
4678 fn sidebar_union(fmt: &mut fmt::Formatter, it: &clean::Item,
4679 u: &clean::Union) -> fmt::Result {
4680 let mut sidebar = String::new();
4681 let fields = get_struct_fields_name(&u.fields);
4683 if !fields.is_empty() {
4684 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#fields\">Fields</a>\
4685 <div class=\"sidebar-links\">{}</div>", fields));
4688 sidebar.push_str(&sidebar_assoc_items(it));
4690 if !sidebar.is_empty() {
4691 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4696 fn sidebar_enum(fmt: &mut fmt::Formatter, it: &clean::Item,
4697 e: &clean::Enum) -> fmt::Result {
4698 let mut sidebar = String::new();
4700 let variants = e.variants.iter()
4701 .filter_map(|v| match v.name {
4702 Some(ref name) => Some(format!("<a href=\"#variant.{name}\">{name}\
4703 </a>", name = name)),
4706 .collect::<String>();
4707 if !variants.is_empty() {
4708 sidebar.push_str(&format!("<a class=\"sidebar-title\" href=\"#variants\">Variants</a>\
4709 <div class=\"sidebar-links\">{}</div>", variants));
4712 sidebar.push_str(&sidebar_assoc_items(it));
4714 if !sidebar.is_empty() {
4715 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4720 fn item_ty_to_strs(ty: &ItemType) -> (&'static str, &'static str) {
4722 ItemType::ExternCrate |
4723 ItemType::Import => ("reexports", "Re-exports"),
4724 ItemType::Module => ("modules", "Modules"),
4725 ItemType::Struct => ("structs", "Structs"),
4726 ItemType::Union => ("unions", "Unions"),
4727 ItemType::Enum => ("enums", "Enums"),
4728 ItemType::Function => ("functions", "Functions"),
4729 ItemType::Typedef => ("types", "Type Definitions"),
4730 ItemType::Static => ("statics", "Statics"),
4731 ItemType::Constant => ("constants", "Constants"),
4732 ItemType::Trait => ("traits", "Traits"),
4733 ItemType::Impl => ("impls", "Implementations"),
4734 ItemType::TyMethod => ("tymethods", "Type Methods"),
4735 ItemType::Method => ("methods", "Methods"),
4736 ItemType::StructField => ("fields", "Struct Fields"),
4737 ItemType::Variant => ("variants", "Variants"),
4738 ItemType::Macro => ("macros", "Macros"),
4739 ItemType::Primitive => ("primitives", "Primitive Types"),
4740 ItemType::AssociatedType => ("associated-types", "Associated Types"),
4741 ItemType::AssociatedConst => ("associated-consts", "Associated Constants"),
4742 ItemType::ForeignType => ("foreign-types", "Foreign Types"),
4743 ItemType::Keyword => ("keywords", "Keywords"),
4744 ItemType::Existential => ("existentials", "Existentials"),
4745 ItemType::ProcAttribute => ("attributes", "Attribute Macros"),
4746 ItemType::ProcDerive => ("derives", "Derive Macros"),
4750 fn sidebar_module(fmt: &mut fmt::Formatter, _it: &clean::Item,
4751 items: &[clean::Item]) -> fmt::Result {
4752 let mut sidebar = String::new();
4754 if items.iter().any(|it| it.type_() == ItemType::ExternCrate ||
4755 it.type_() == ItemType::Import) {
4756 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
4758 name = "Re-exports"));
4761 // ordering taken from item_module, reorder, where it prioritized elements in a certain order
4762 // to print its headings
4763 for &myty in &[ItemType::Primitive, ItemType::Module, ItemType::Macro, ItemType::Struct,
4764 ItemType::Enum, ItemType::Constant, ItemType::Static, ItemType::Trait,
4765 ItemType::Function, ItemType::Typedef, ItemType::Union, ItemType::Impl,
4766 ItemType::TyMethod, ItemType::Method, ItemType::StructField, ItemType::Variant,
4767 ItemType::AssociatedType, ItemType::AssociatedConst, ItemType::ForeignType] {
4768 if items.iter().any(|it| !it.is_stripped() && it.type_() == myty) {
4769 let (short, name) = item_ty_to_strs(&myty);
4770 sidebar.push_str(&format!("<li><a href=\"#{id}\">{name}</a></li>",
4776 if !sidebar.is_empty() {
4777 write!(fmt, "<div class=\"block items\"><ul>{}</ul></div>", sidebar)?;
4782 fn sidebar_foreign_type(fmt: &mut fmt::Formatter, it: &clean::Item) -> fmt::Result {
4783 let sidebar = sidebar_assoc_items(it);
4784 if !sidebar.is_empty() {
4785 write!(fmt, "<div class=\"block items\">{}</div>", sidebar)?;
4790 impl<'a> fmt::Display for Source<'a> {
4791 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
4792 let Source(s) = *self;
4793 let lines = s.lines().count();
4795 let mut tmp = lines;
4800 write!(fmt, "<pre class=\"line-numbers\">")?;
4801 for i in 1..=lines {
4802 write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
4804 write!(fmt, "</pre>")?;
4806 highlight::render_with_highlighting(s, None, None, None))?;
4811 fn item_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
4812 t: &clean::Macro) -> fmt::Result {
4813 wrap_into_docblock(w, |w| {
4814 w.write_str(&highlight::render_with_highlighting(&t.source,
4822 fn item_proc_macro(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, m: &clean::ProcMacro)
4825 let name = it.name.as_ref().expect("proc-macros always have names");
4827 MacroKind::Bang => {
4828 write!(w, "<pre class='rust macro'>")?;
4829 write!(w, "{}!() {{ /* proc-macro */ }}", name)?;
4830 write!(w, "</pre>")?;
4832 MacroKind::Attr => {
4833 write!(w, "<pre class='rust attr'>")?;
4834 write!(w, "#[{}]", name)?;
4835 write!(w, "</pre>")?;
4837 MacroKind::Derive => {
4838 write!(w, "<pre class='rust derive'>")?;
4839 write!(w, "#[derive({})]", name)?;
4840 if !m.helpers.is_empty() {
4841 writeln!(w, "\n{{")?;
4842 writeln!(w, " // Attributes available to this derive:")?;
4843 for attr in &m.helpers {
4844 writeln!(w, " #[{}]", attr)?;
4848 write!(w, "</pre>")?;
4855 fn item_primitive(w: &mut fmt::Formatter, cx: &Context,
4857 _p: &clean::PrimitiveType) -> fmt::Result {
4858 document(w, cx, it)?;
4859 render_assoc_items(w, cx, it, it.def_id, AssocItemRender::All)
4862 fn item_keyword(w: &mut fmt::Formatter, cx: &Context,
4864 _p: &str) -> fmt::Result {
4868 const BASIC_KEYWORDS: &'static str = "rust, rustlang, rust-lang";
4870 fn make_item_keywords(it: &clean::Item) -> String {
4871 format!("{}, {}", BASIC_KEYWORDS, it.name.as_ref().unwrap())
4874 fn get_index_search_type(item: &clean::Item) -> Option<IndexItemFunctionType> {
4875 let decl = match item.inner {
4876 clean::FunctionItem(ref f) => &f.decl,
4877 clean::MethodItem(ref m) => &m.decl,
4878 clean::TyMethodItem(ref m) => &m.decl,
4882 let inputs = decl.inputs.values.iter().map(|arg| get_index_type(&arg.type_)).collect();
4883 let output = match decl.output {
4884 clean::FunctionRetTy::Return(ref return_type) => Some(get_index_type(return_type)),
4888 Some(IndexItemFunctionType { inputs: inputs, output: output })
4891 fn get_index_type(clean_type: &clean::Type) -> Type {
4893 name: get_index_type_name(clean_type, true).map(|s| s.to_ascii_lowercase()),
4894 generics: get_generics(clean_type),
4899 /// Returns a list of all paths used in the type.
4900 /// This is used to help deduplicate imported impls
4901 /// for reexported types. If any of the contained
4902 /// types are re-exported, we don't use the corresponding
4903 /// entry from the js file, as inlining will have already
4904 /// picked up the impl
4905 fn collect_paths_for_type(first_ty: clean::Type) -> Vec<String> {
4906 let mut out = Vec::new();
4907 let mut visited = FxHashSet::default();
4908 let mut work = VecDeque::new();
4909 let cache = cache();
4911 work.push_back(first_ty);
4913 while let Some(ty) = work.pop_front() {
4914 if !visited.insert(ty.clone()) {
4919 clean::Type::ResolvedPath { did, .. } => {
4920 let get_extern = || cache.external_paths.get(&did).map(|s| s.0.clone());
4921 let fqp = cache.exact_paths.get(&did).cloned().or_else(get_extern);
4925 out.push(path.join("::"));
4931 clean::Type::Tuple(tys) => {
4932 work.extend(tys.into_iter());
4934 clean::Type::Slice(ty) => {
4935 work.push_back(*ty);
4937 clean::Type::Array(ty, _) => {
4938 work.push_back(*ty);
4940 clean::Type::Unique(ty) => {
4941 work.push_back(*ty);
4943 clean::Type::RawPointer(_, ty) => {
4944 work.push_back(*ty);
4946 clean::Type::BorrowedRef { type_, .. } => {
4947 work.push_back(*type_);
4949 clean::Type::QPath { self_type, trait_, .. } => {
4950 work.push_back(*self_type);
4951 work.push_back(*trait_);
4959 fn get_index_type_name(clean_type: &clean::Type, accept_generic: bool) -> Option<String> {
4961 clean::ResolvedPath { ref path, .. } => {
4962 let segments = &path.segments;
4963 let path_segment = segments.into_iter().last().unwrap_or_else(|| panic!(
4964 "get_index_type_name(clean_type: {:?}, accept_generic: {:?}) had length zero path",
4965 clean_type, accept_generic
4967 Some(path_segment.name.clone())
4969 clean::Generic(ref s) if accept_generic => Some(s.clone()),
4970 clean::Primitive(ref p) => Some(format!("{:?}", p)),
4971 clean::BorrowedRef { ref type_, .. } => get_index_type_name(type_, accept_generic),
4972 // FIXME: add all from clean::Type.
4977 fn get_generics(clean_type: &clean::Type) -> Option<Vec<String>> {
4978 clean_type.generics()
4980 let r = types.iter()
4981 .filter_map(|t| get_index_type_name(t, false))
4982 .map(|s| s.to_ascii_lowercase())
4983 .collect::<Vec<_>>();
4992 pub fn cache() -> Arc<Cache> {
4993 CACHE_KEY.with(|c| c.borrow().clone())
4998 fn test_name_key() {
4999 assert_eq!(name_key("0"), ("", 0, 1));
5000 assert_eq!(name_key("123"), ("", 123, 0));
5001 assert_eq!(name_key("Fruit"), ("Fruit", 0, 0));
5002 assert_eq!(name_key("Fruit0"), ("Fruit", 0, 1));
5003 assert_eq!(name_key("Fruit0000"), ("Fruit", 0, 4));
5004 assert_eq!(name_key("Fruit01"), ("Fruit", 1, 1));
5005 assert_eq!(name_key("Fruit10"), ("Fruit", 10, 0));
5006 assert_eq!(name_key("Fruit123"), ("Fruit", 123, 0));
5011 fn test_name_sorting() {
5012 let names = ["Apple",
5014 "Fruit", "Fruit0", "Fruit00",
5015 "Fruit1", "Fruit01",
5016 "Fruit2", "Fruit02",
5021 let mut sorted = names.to_owned();
5022 sorted.sort_by_key(|&s| name_key(s));
5023 assert_eq!(names, sorted);