1 use std
::path
::PathBuf
;
3 use crate::externalfiles
::ExternalHtml
;
4 use crate::html
::escape
::Escape
;
5 use crate::html
::format
::{Buffer, Print}
;
6 use crate::html
::render
::{ensure_trailing_slash, StylePath}
;
12 pub external_html
: ExternalHtml
,
14 /// The given user css file which allow to customize the generated
15 /// documentation theme.
16 pub css_file_extension
: Option
<PathBuf
>,
17 /// If false, the `select` element to have search filtering by crates on rendered docs
18 /// won't be generated.
19 pub generate_search_filter
: bool
,
24 pub css_class
: &'a
str,
25 pub root_path
: &'a
str,
26 pub static_root_path
: Option
<&'a
str>,
27 pub description
: &'a
str,
28 pub keywords
: &'a
str,
29 pub resource_suffix
: &'a
str,
30 pub extra_scripts
: &'a
[&'a
str],
31 pub static_extra_scripts
: &'a
[&'a
str],
34 pub fn render
<T
: Print
, S
: Print
>(
39 style_files
: &[StylePath
],
41 let static_root_path
= page
.static_root_path
.unwrap_or(page
.root_path
);
46 <meta charset=\"utf-8\">\
47 <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\
48 <meta name=\"generator\" content=\"rustdoc\">\
49 <meta name=\"description\" content=\"{description}\">\
50 <meta name=\"keywords\" content=\"{keywords}\">\
51 <title>{title}</title>\
52 <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}normalize{suffix}.css\">\
53 <link rel=\"stylesheet\" type=\"text/css\" href=\"{static_root_path}rustdoc{suffix}.css\" \
54 id=\"mainThemeStyle\">\
56 <script src=\"{static_root_path}storage{suffix}.js\"></script>\
57 <noscript><link rel=\"stylesheet\" href=\"{static_root_path}noscript{suffix}.css\"></noscript>\
61 <style type=\"text/css\">\
62 #crate-search{{background-image:url(\"{static_root_path}down-arrow{suffix}.svg\");}}\
65 <body class=\"rustdoc {css_class}\">\
67 <div class=\"warning\">\
68 This old browser is unsupported and will most likely display funky \
73 <nav class=\"sidebar\">\
74 <div class=\"sidebar-menu\">☰</div>\
78 <div class=\"theme-picker\">\
79 <button id=\"theme-picker\" aria-label=\"Pick another theme!\">\
80 <img src=\"{static_root_path}brush{suffix}.svg\" \
82 alt=\"Pick another theme!\">\
84 <div id=\"theme-choices\"></div>\
86 <script src=\"{static_root_path}theme{suffix}.js\"></script>\
88 <form class=\"search-form\">\
89 <div class=\"search-container\">\
91 <input class=\"search-input\" name=\"search\" \
93 autocomplete=\"off\" \
94 spellcheck=\"false\" \
95 placeholder=\"Click or press ‘S’ to search, ‘?’ for more options…\" \
98 <span class=\"help-button\">?</span>
99 <a id=\"settings-menu\" href=\"{root_path}settings.html\">\
100 <img src=\"{static_root_path}wheel{suffix}.svg\" \
102 alt=\"Change settings\">\
107 <section id=\"main\" class=\"content\">{content}</section>\
108 <section id=\"search\" class=\"content hidden\"></section>\
109 <section class=\"footer\"></section>\
112 window.rootPath = \"{root_path}\";\
113 window.currentCrate = \"{krate}\";\
115 <script src=\"{static_root_path}main{suffix}.js\"></script>\
116 {static_extra_scripts}\
118 <script defer src=\"{root_path}search-index{suffix}.js\"></script>\
121 css_extension
= if layout
.css_file_extension
.is_some() {
123 "<link rel=\"stylesheet\" \
125 href=\"{static_root_path}theme{suffix}.css\">",
126 static_root_path
= static_root_path
,
127 suffix
= page
.resource_suffix
132 content
= Buffer
::html().to_display(t
),
133 static_root_path
= static_root_path
,
134 root_path
= page
.root_path
,
135 css_class
= page
.css_class
,
137 let p
= format
!("{}{}", page
.root_path
, layout
.krate
);
138 let p
= ensure_trailing_slash(&p
);
139 if layout
.logo
.is_empty() {
141 "<a href='{path}index.html'>\
142 <div class='logo-container rust-logo'>\
143 <img src='{static_root_path}rust-logo{suffix}.png' alt='logo'></div></a>",
145 static_root_path
= static_root_path
,
146 suffix
= page
.resource_suffix
150 "<a href='{}index.html'>\
151 <div class='logo-container'><img src='{}' alt='logo'></div></a>",
157 description
= page
.description
,
158 keywords
= page
.keywords
,
159 favicon
= if layout
.favicon
.is_empty() {
161 r
##"<link rel="icon" type="image/svg+xml" href="{static_root_path}favicon{suffix}.svg">
162 <link rel="alternate icon" type="image/png" href="{static_root_path}favicon-16x16{suffix}.png">
163 <link rel="alternate icon" type="image/png" href="{static_root_path}favicon-32x32{suffix}.png">"##,
164 static_root_path
= static_root_path
,
165 suffix
= page
.resource_suffix
168 format
!(r
#"<link rel="shortcut icon" href="{}">"#, layout.favicon)
170 in_header
= layout
.external_html
.in_header
,
171 before_content
= layout
.external_html
.before_content
,
172 after_content
= layout
.external_html
.after_content
,
173 sidebar
= Buffer
::html().to_display(sidebar
),
174 krate
= layout
.krate
,
175 style_files
= style_files
178 if let Some(stem
) = t
.path
.file_stem() { Some((stem, t.disabled)) }
else { None }
181 if let Some(path
) = t
.0.to_str() { Some((path, t.1)) }
else { None }
184 r
#"<link rel="stylesheet" type="text/css" href="{}.css" {} {}>"#,
185 Escape(&format
!("{}{}{}", static_root_path
, t
.0, page
.resource_suffix
)),
186 if t
.1 { "disabled" }
else { "" }
,
187 if t
.0 == "light" { "id=\"themeStyle\"" }
else { "" }
189 .collect
::<String
>(),
190 suffix
= page
.resource_suffix
,
191 static_extra_scripts
= page
192 .static_extra_scripts
196 "<script src=\"{static_root_path}{extra_script}.js\"></script>",
197 static_root_path
= static_root_path
,
201 .collect
::<String
>(),
207 "<script src=\"{root_path}{extra_script}.js\"></script>",
208 root_path
= page
.root_path
,
212 .collect
::<String
>(),
213 filter_crates
= if layout
.generate_search_filter
{
214 "<select id=\"crate-search\">\
215 <option value=\"All crates\">All crates</option>\
223 pub fn redirect(url
: &str) -> String
{
224 // <script> triggers a redirect before refresh, so this is fine.
229 <meta http-equiv="refresh" content="0;URL={url}">
232 <p>Redirecting to <a href="{url}">{url}</a>...</p>
233 <script>location.replace("{url}" + location.search + location.hash);</script>