forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmain.js
2141 lines (1998 loc) · 83.8 KB
/
main.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Local js definitions:
/* global addClass, getSettingValue, hasClass, updateLocalStorage */
/* global onEachLazy, removeClass, getVar */
"use strict";
// The amount of time that the cursor must remain still over a hover target before
// revealing a tooltip.
//
// https://www.nngroup.com/articles/timing-exposing-content/
window.RUSTDOC_TOOLTIP_HOVER_MS = 300;
window.RUSTDOC_TOOLTIP_HOVER_EXIT_MS = 450;
/**
* Given a basename (e.g. "storage") and an extension (e.g. ".js"), return a URL
* for a resource under the root-path, with the resource-suffix.
*
* @param {string} basename
* @param {string} extension
*/
function resourcePath(basename, extension) {
return getVar("root-path") + basename + getVar("resource-suffix") + extension;
}
function hideMain() {
addClass(document.getElementById(MAIN_ID), "hidden");
const toggle = document.getElementById("toggle-all-docs");
if (toggle) {
toggle.setAttribute("disabled", "disabled");
}
}
function showMain() {
const main = document.getElementById(MAIN_ID);
if (!main) {
return;
}
removeClass(main, "hidden");
const mainHeading = main.querySelector(".main-heading");
if (mainHeading && window.searchState.rustdocToolbar) {
if (window.searchState.rustdocToolbar.parentElement) {
window.searchState.rustdocToolbar.parentElement.removeChild(
window.searchState.rustdocToolbar,
);
}
mainHeading.appendChild(window.searchState.rustdocToolbar);
}
const toggle = document.getElementById("toggle-all-docs");
if (toggle) {
toggle.removeAttribute("disabled");
}
}
window.rootPath = getVar("root-path");
window.currentCrate = getVar("current-crate");
function setMobileTopbar() {
// FIXME: It would be nicer to generate this text content directly in HTML,
// but with the current code it's hard to get the right information in the right place.
const mobileTopbar = document.querySelector(".mobile-topbar");
const locationTitle = document.querySelector(".sidebar h2.location");
if (mobileTopbar) {
const mobileTitle = document.createElement("h2");
mobileTitle.className = "location";
if (hasClass(document.querySelector(".rustdoc"), "crate")) {
mobileTitle.innerHTML = `Crate <a href="#">${window.currentCrate}</a>`;
} else if (locationTitle) {
mobileTitle.innerHTML = locationTitle.innerHTML;
}
mobileTopbar.appendChild(mobileTitle);
}
}
/**
* Gets the human-readable string for the virtual-key code of the
* given KeyboardEvent, ev.
*
* This function is meant as a polyfill for KeyboardEvent#key,
* since it is not supported in IE 11 or Chrome for Android. We also test for
* KeyboardEvent#keyCode because the handleShortcut handler is
* also registered for the keydown event, because Blink doesn't fire
* keypress on hitting the Escape key.
*
* So I guess you could say things are getting pretty interoperable.
*
* @param {KeyboardEvent} ev
*/
function getVirtualKey(ev) {
if ("key" in ev && typeof ev.key !== "undefined") {
return ev.key;
}
const c = ev.charCode || ev.keyCode;
if (c === 27) {
return "Escape";
}
return String.fromCharCode(c);
}
const MAIN_ID = "main-content";
const SETTINGS_BUTTON_ID = "settings-menu";
const ALTERNATIVE_DISPLAY_ID = "alternative-display";
const NOT_DISPLAYED_ID = "not-displayed";
const HELP_BUTTON_ID = "help-button";
function getSettingsButton() {
return document.getElementById(SETTINGS_BUTTON_ID);
}
function getHelpButton() {
return document.getElementById(HELP_BUTTON_ID);
}
// Returns the current URL without any query parameter or hash.
function getNakedUrl() {
return window.location.href.split("?")[0].split("#")[0];
}
/**
* This function inserts `newNode` after `referenceNode`. It doesn't work if `referenceNode`
* doesn't have a parent node.
*
* @param {HTMLElement} newNode
* @param {HTMLElement & { parentNode: HTMLElement }} referenceNode
*/
function insertAfter(newNode, referenceNode) {
referenceNode.parentNode.insertBefore(newNode, referenceNode.nextSibling);
}
/**
* This function creates a new `<section>` with the given `id` and `classes` if it doesn't already
* exist.
*
* More information about this in `switchDisplayedElement` documentation.
*
* @param {string} id
* @param {string} classes
*/
function getOrCreateSection(id, classes) {
let el = document.getElementById(id);
if (!el) {
el = document.createElement("section");
el.id = id;
el.className = classes;
// @ts-expect-error
insertAfter(el, document.getElementById(MAIN_ID));
}
return el;
}
/**
* Returns the `<section>` element which contains the displayed element.
*
* @return {HTMLElement}
*/
function getAlternativeDisplayElem() {
return getOrCreateSection(ALTERNATIVE_DISPLAY_ID, "content hidden");
}
/**
* Returns the `<section>` element which contains the not-displayed elements.
*
* @return {HTMLElement}
*/
function getNotDisplayedElem() {
return getOrCreateSection(NOT_DISPLAYED_ID, "hidden");
}
/**
* To nicely switch between displayed "extra" elements (such as search results or settings menu)
* and to alternate between the displayed and not displayed elements, we hold them in two different
* `<section>` elements. They work in pair: one holds the hidden elements while the other
* contains the displayed element (there can be only one at the same time!). So basically, we switch
* elements between the two `<section>` elements.
*
* @param {HTMLElement|null} elemToDisplay
*/
function switchDisplayedElement(elemToDisplay) {
const el = getAlternativeDisplayElem();
if (el.children.length > 0) {
// @ts-expect-error
getNotDisplayedElem().appendChild(el.firstElementChild);
}
if (elemToDisplay === null) {
addClass(el, "hidden");
showMain();
return;
}
el.appendChild(elemToDisplay);
hideMain();
removeClass(el, "hidden");
const mainHeading = elemToDisplay.querySelector(".main-heading");
if (mainHeading && window.searchState.rustdocToolbar) {
if (window.searchState.rustdocToolbar.parentElement) {
window.searchState.rustdocToolbar.parentElement.removeChild(
window.searchState.rustdocToolbar,
);
}
mainHeading.appendChild(window.searchState.rustdocToolbar);
}
}
function browserSupportsHistoryApi() {
return window.history && typeof window.history.pushState === "function";
}
/**
* Download CSS from the web without making it the active stylesheet.
* We use this in the settings popover so that you don't get FOUC when switching.
*
* @param {string} cssUrl
*/
function preLoadCss(cssUrl) {
// https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types/preload
const link = document.createElement("link");
link.href = cssUrl;
link.rel = "preload";
link.as = "style";
document.getElementsByTagName("head")[0].appendChild(link);
}
(function() {
const isHelpPage = window.location.pathname.endsWith("/help.html");
/**
* Run a JavaScript file asynchronously.
* @param {string} url
* @param {function(): any} errorCallback
*/
function loadScript(url, errorCallback) {
const script = document.createElement("script");
script.src = url;
if (errorCallback !== undefined) {
script.onerror = errorCallback;
}
document.head.append(script);
}
const settingsButton = getSettingsButton();
if (settingsButton) {
settingsButton.onclick = event => {
if (event.ctrlKey || event.altKey || event.metaKey) {
return;
}
window.hideAllModals(false);
addClass(getSettingsButton(), "rotate");
event.preventDefault();
// Sending request for the CSS and the JS files at the same time so it will
// hopefully be loaded when the JS will generate the settings content.
// @ts-expect-error
loadScript(getVar("static-root-path") + getVar("settings-js"));
// Pre-load all theme CSS files, so that switching feels seamless.
//
// When loading settings.html as a standalone page, the equivalent HTML is
// generated in context.rs.
setTimeout(() => {
// @ts-expect-error
const themes = getVar("themes").split(",");
for (const theme of themes) {
// if there are no themes, do nothing
// "".split(",") == [""]
if (theme !== "") {
preLoadCss(getVar("root-path") + theme + ".css");
}
}
}, 0);
};
}
window.searchState = {
rustdocToolbar: document.querySelector("rustdoc-toolbar"),
loadingText: "Loading search results...",
// This will always be an HTMLInputElement, but tsc can't see that
// @ts-expect-error
input: document.getElementsByClassName("search-input")[0],
outputElement: () => {
let el = document.getElementById("search");
if (!el) {
el = document.createElement("section");
el.id = "search";
getNotDisplayedElem().appendChild(el);
}
return el;
},
title: document.title,
titleBeforeSearch: document.title,
timeout: null,
// On the search screen, so you remain on the last tab you opened.
//
// 0 for "In Names"
// 1 for "In Parameters"
// 2 for "In Return Types"
currentTab: 0,
// tab and back preserves the element that was focused.
focusedByTab: [null, null, null],
clearInputTimeout: () => {
if (window.searchState.timeout !== null) {
clearTimeout(window.searchState.timeout);
window.searchState.timeout = null;
}
},
isDisplayed: () => {
const outputElement = window.searchState.outputElement();
return !!outputElement &&
!!outputElement.parentElement &&
outputElement.parentElement.id === ALTERNATIVE_DISPLAY_ID;
},
// Sets the focus on the search bar at the top of the page
focus: () => {
window.searchState.input && window.searchState.input.focus();
},
// Removes the focus from the search bar.
defocus: () => {
window.searchState.input && window.searchState.input.blur();
},
showResults: search => {
if (search === null || typeof search === "undefined") {
search = window.searchState.outputElement();
}
switchDisplayedElement(search);
document.title = window.searchState.title;
},
removeQueryParameters: () => {
// We change the document title.
document.title = window.searchState.titleBeforeSearch;
if (browserSupportsHistoryApi()) {
history.replaceState(null, "", getNakedUrl() + window.location.hash);
}
},
hideResults: () => {
switchDisplayedElement(null);
// We also remove the query parameter from the URL.
window.searchState.removeQueryParameters();
},
getQueryStringParams: () => {
/** @type {Object.<any, string>} */
const params = {};
window.location.search.substring(1).split("&").
map(s => {
// https://github.com/rust-lang/rust/issues/119219
const pair = s.split("=").map(x => x.replace(/\+/g, " "));
params[decodeURIComponent(pair[0])] =
typeof pair[1] === "undefined" ? null : decodeURIComponent(pair[1]);
});
return params;
},
setup: () => {
const search_input = window.searchState.input;
if (!search_input) {
return;
}
let searchLoaded = false;
// If you're browsing the nightly docs, the page might need to be refreshed for the
// search to work because the hash of the JS scripts might have changed.
function sendSearchForm() {
// @ts-expect-error
document.getElementsByClassName("search-form")[0].submit();
}
function loadSearch() {
if (!searchLoaded) {
searchLoaded = true;
// @ts-expect-error
loadScript(getVar("static-root-path") + getVar("search-js"), sendSearchForm);
loadScript(resourcePath("search-index", ".js"), sendSearchForm);
}
}
search_input.addEventListener("focus", () => {
window.searchState.origPlaceholder = search_input.placeholder;
search_input.placeholder = "Type your search here.";
loadSearch();
});
if (search_input.value !== "") {
loadSearch();
}
const params = window.searchState.getQueryStringParams();
if (params.search !== undefined) {
window.searchState.setLoadingSearch();
loadSearch();
}
},
setLoadingSearch: () => {
const search = window.searchState.outputElement();
if (!search) {
return;
}
search.innerHTML = "<h3 class=\"search-loading\">" +
window.searchState.loadingText +
"</h3>";
window.searchState.showResults(search);
},
descShards: new Map(),
loadDesc: async function({descShard, descIndex}) {
if (descShard.promise === null) {
descShard.promise = new Promise((resolve, reject) => {
// The `resolve` callback is stored in the `descShard`
// object, which is itself stored in `this.descShards` map.
// It is called in `loadedDescShard` by the
// search.desc script.
descShard.resolve = resolve;
const ds = descShard;
const fname = `${ds.crate}-desc-${ds.shard}-`;
const url = resourcePath(
`search.desc/${descShard.crate}/${fname}`,
".js",
);
loadScript(url, reject);
});
}
const list = await descShard.promise;
return list[descIndex];
},
loadedDescShard: function(crate, shard, data) {
// If loadedDescShard gets called, then the library must have been declared.
// @ts-expect-error
this.descShards.get(crate)[shard].resolve(data.split("\n"));
},
};
const toggleAllDocsId = "toggle-all-docs";
let savedHash = "";
/**
* @param {HashChangeEvent|null} ev
*/
function handleHashes(ev) {
if (ev !== null && window.searchState.isDisplayed() && ev.newURL) {
// This block occurs when clicking on an element in the navbar while
// in a search.
switchDisplayedElement(null);
const hash = ev.newURL.slice(ev.newURL.indexOf("#") + 1);
if (browserSupportsHistoryApi()) {
// `window.location.search`` contains all the query parameters, not just `search`.
history.replaceState(null, "",
getNakedUrl() + window.location.search + "#" + hash);
}
const elem = document.getElementById(hash);
if (elem) {
elem.scrollIntoView();
}
}
// This part is used in case an element is not visible.
const pageId = window.location.hash.replace(/^#/, "");
if (savedHash !== pageId) {
savedHash = pageId;
if (pageId !== "") {
expandSection(pageId);
}
}
if (savedHash.startsWith("impl-")) {
// impl-disambiguated links, used by the search engine
// format: impl-X[-for-Y]/method.WHATEVER
// turn this into method.WHATEVER[-NUMBER]
const splitAt = savedHash.indexOf("/");
if (splitAt !== -1) {
const implId = savedHash.slice(0, splitAt);
const assocId = savedHash.slice(splitAt + 1);
const implElems = document.querySelectorAll(
`details > summary > section[id^="${implId}"]`,
);
onEachLazy(implElems, implElem => {
const numbered = /^(.+?)-([0-9]+)$/.exec(implElem.id);
if (implElem.id !== implId && (!numbered || numbered[1] !== implId)) {
return false;
}
return onEachLazy(implElem.parentElement.parentElement.querySelectorAll(
`[id^="${assocId}"]`),
item => {
const numbered = /^(.+?)-([0-9]+)$/.exec(item.id);
if (item.id === assocId || (numbered && numbered[1] === assocId)) {
openParentDetails(item);
item.scrollIntoView();
// Let the section expand itself before trying to highlight
setTimeout(() => {
window.location.replace("#" + item.id);
}, 0);
return true;
}
},
);
});
}
}
}
/**
* @param {HashChangeEvent|null} ev
*/
function onHashChange(ev) {
// If we're in mobile mode, we should hide the sidebar in any case.
hideSidebar();
handleHashes(ev);
}
/**
* @param {HTMLElement|null} elem
*/
function openParentDetails(elem) {
while (elem) {
if (elem.tagName === "DETAILS") {
// @ts-expect-error
elem.open = true;
}
elem = elem.parentElement;
}
}
/**
* @param {string} id
*/
function expandSection(id) {
openParentDetails(document.getElementById(id));
}
/**
* @param {KeyboardEvent} ev
*/
function handleEscape(ev) {
window.searchState.clearInputTimeout();
window.searchState.hideResults();
ev.preventDefault();
window.searchState.defocus();
window.hideAllModals(true); // true = reset focus for tooltips
}
/**
* @param {KeyboardEvent} ev
*/
function handleShortcut(ev) {
// Don't interfere with browser shortcuts
const disableShortcuts = getSettingValue("disable-shortcuts") === "true";
if (ev.ctrlKey || ev.altKey || ev.metaKey || disableShortcuts) {
return;
}
if (document.activeElement &&
document.activeElement.tagName === "INPUT" &&
// @ts-expect-error
document.activeElement.type !== "checkbox" &&
// @ts-expect-error
document.activeElement.type !== "radio") {
switch (getVirtualKey(ev)) {
case "Escape":
handleEscape(ev);
break;
}
} else {
switch (getVirtualKey(ev)) {
case "Escape":
handleEscape(ev);
break;
case "s":
case "S":
case "/":
ev.preventDefault();
window.searchState.focus();
break;
case "+":
ev.preventDefault();
expandAllDocs();
break;
case "-":
ev.preventDefault();
collapseAllDocs();
break;
case "?":
showHelp();
break;
default:
break;
}
}
}
document.addEventListener("keypress", handleShortcut);
document.addEventListener("keydown", handleShortcut);
function addSidebarItems() {
if (!window.SIDEBAR_ITEMS) {
return;
}
const sidebar = document.getElementById("rustdoc-modnav");
/**
* Append to the sidebar a "block" of links - a heading along with a list (`<ul>`) of items.
*
* @param {string} shortty - A short type name, like "primitive", "mod", or "macro"
* @param {string} id - The HTML id of the corresponding section on the module page.
* @param {string} longty - A long, capitalized, plural name, like "Primitive Types",
* "Modules", or "Macros".
*/
function block(shortty, id, longty) {
// @ts-expect-error
const filtered = window.SIDEBAR_ITEMS[shortty];
if (!filtered) {
return;
}
const modpath = hasClass(document.querySelector(".rustdoc"), "mod") ? "../" : "";
const h3 = document.createElement("h3");
h3.innerHTML = `<a href="${modpath}index.html#${id}">${longty}</a>`;
const ul = document.createElement("ul");
ul.className = "block " + shortty;
for (const name of filtered) {
let path;
if (shortty === "mod") {
path = `${modpath}${name}/index.html`;
} else {
path = `${modpath}${shortty}.${name}.html`;
}
let current_page = document.location.href.toString();
if (current_page.endsWith("/")) {
current_page += "index.html";
}
const link = document.createElement("a");
link.href = path;
link.textContent = name;
const li = document.createElement("li");
// Don't "optimize" this to just use `path`.
// We want the browser to normalize this into an absolute URL.
if (link.href === current_page) {
li.classList.add("current");
}
li.appendChild(link);
ul.appendChild(li);
}
// @ts-expect-error
sidebar.appendChild(h3);
// @ts-expect-error
sidebar.appendChild(ul);
}
if (sidebar) {
// keep this synchronized with ItemSection::ALL in html/render/mod.rs
// Re-exports aren't shown here, because they don't have child pages
//block("reexport", "reexports", "Re-exports");
block("primitive", "primitives", "Primitive Types");
block("mod", "modules", "Modules");
block("macro", "macros", "Macros");
block("struct", "structs", "Structs");
block("enum", "enums", "Enums");
block("constant", "constants", "Constants");
block("static", "static", "Statics");
block("trait", "traits", "Traits");
block("fn", "functions", "Functions");
block("type", "types", "Type Aliases");
block("union", "unions", "Unions");
// No point, because these items don't appear in modules
//block("impl", "impls", "Implementations");
//block("tymethod", "tymethods", "Type Methods");
//block("method", "methods", "Methods");
//block("structfield", "fields", "Fields");
//block("variant", "variants", "Variants");
//block("associatedtype", "associated-types", "Associated Types");
//block("associatedconstant", "associated-consts", "Associated Constants");
block("foreigntype", "foreign-types", "Foreign Types");
block("keyword", "keywords", "Keywords");
block("attr", "attributes", "Attribute Macros");
block("derive", "derives", "Derive Macros");
block("traitalias", "trait-aliases", "Trait Aliases");
}
}
// <https://github.com/search?q=repo%3Arust-lang%2Frust+[RUSTDOCIMPL]+trait.impl&type=code>
window.register_implementors = imp => {
const implementors = document.getElementById("implementors-list");
const synthetic_implementors = document.getElementById("synthetic-implementors-list");
const inlined_types = new Set();
const TEXT_IDX = 0;
const SYNTHETIC_IDX = 1;
const TYPES_IDX = 2;
if (synthetic_implementors) {
// This `inlined_types` variable is used to avoid having the same implementation
// showing up twice. For example "String" in the "Sync" doc page.
//
// By the way, this is only used by and useful for traits implemented automatically
// (like "Send" and "Sync").
onEachLazy(synthetic_implementors.getElementsByClassName("impl"), el => {
const aliases = el.getAttribute("data-aliases");
if (!aliases) {
return;
}
// @ts-expect-error
aliases.split(",").forEach(alias => {
inlined_types.add(alias);
});
});
}
// @ts-expect-error
let currentNbImpls = implementors.getElementsByClassName("impl").length;
// @ts-expect-error
const traitName = document.querySelector(".main-heading h1 > .trait").textContent;
const baseIdName = "impl-" + traitName + "-";
const libs = Object.getOwnPropertyNames(imp);
// We don't want to include impls from this JS file, when the HTML already has them.
// The current crate should always be ignored. Other crates that should also be
// ignored are included in the attribute `data-ignore-extern-crates`.
const script = document
.querySelector("script[data-ignore-extern-crates]");
const ignoreExternCrates = new Set(
// @ts-expect-error
(script ? script.getAttribute("data-ignore-extern-crates") : "").split(","),
);
for (const lib of libs) {
if (lib === window.currentCrate || ignoreExternCrates.has(lib)) {
continue;
}
const structs = imp[lib];
struct_loop:
for (const struct of structs) {
const list = struct[SYNTHETIC_IDX] ? synthetic_implementors : implementors;
// The types list is only used for synthetic impls.
// If this changes, `main.js` and `write_shared.rs` both need changed.
if (struct[SYNTHETIC_IDX]) {
for (const struct_type of struct[TYPES_IDX]) {
if (inlined_types.has(struct_type)) {
continue struct_loop;
}
inlined_types.add(struct_type);
}
}
const code = document.createElement("h3");
code.innerHTML = struct[TEXT_IDX];
addClass(code, "code-header");
onEachLazy(code.getElementsByTagName("a"), elem => {
const href = elem.getAttribute("href");
if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
elem.setAttribute("href", window.rootPath + href);
}
});
const currentId = baseIdName + currentNbImpls;
const anchor = document.createElement("a");
anchor.href = "#" + currentId;
addClass(anchor, "anchor");
const display = document.createElement("div");
display.id = currentId;
addClass(display, "impl");
display.appendChild(anchor);
display.appendChild(code);
// @ts-expect-error
list.appendChild(display);
currentNbImpls += 1;
}
}
};
if (window.pending_implementors) {
window.register_implementors(window.pending_implementors);
}
/**
* <https://github.com/search?q=repo%3Arust-lang%2Frust+[RUSTDOCIMPL]+type.impl&type=code>
*
* [RUSTDOCIMPL] type.impl
*
* This code inlines implementations into the type alias docs at runtime. It's done at
* runtime because some crates have many type aliases and many methods, and we don't want
* to generate *O*`(types*methods)` HTML text. The data inside is mostly HTML fragments,
* wrapped in JSON.
*
* - It only includes docs generated for the current crate. This function accepts an
* object mapping crate names to the set of impls.
*
* - It filters down to the set of applicable impls. The Rust type checker is used to
* tag each HTML blob with the set of type aliases that can actually use it, so the
* JS only needs to consult the attached list of type aliases.
*
* - It renames the ID attributes, to avoid conflicting IDs in the resulting DOM.
*
* - It adds the necessary items to the sidebar. If it's an inherent impl, that means
* adding methods, associated types, and associated constants. If it's a trait impl,
* that means adding it to the trait impl sidebar list.
*
* - It adds the HTML block itself. If it's an inherent impl, it goes after the type
* alias's own inherent impls. If it's a trait impl, it goes in the Trait
* Implementations section.
*
* - After processing all of the impls, it sorts the sidebar items by name.
*
* @param {rustdoc.TypeImpls} imp
*/
window.register_type_impls = imp => {
// @ts-expect-error
if (!imp || !imp[window.currentCrate]) {
return;
}
window.pending_type_impls = undefined;
const idMap = new Map();
let implementations = document.getElementById("implementations-list");
let trait_implementations = document.getElementById("trait-implementations-list");
let trait_implementations_header = document.getElementById("trait-implementations");
// We want to include the current type alias's impls, and no others.
const script = document.querySelector("script[data-self-path]");
const selfPath = script ? script.getAttribute("data-self-path") : null;
// These sidebar blocks need filled in, too.
const mainContent = document.querySelector("#main-content");
const sidebarSection = document.querySelector(".sidebar section");
let methods = document.querySelector(".sidebar .block.method");
let associatedTypes = document.querySelector(".sidebar .block.associatedtype");
let associatedConstants = document.querySelector(".sidebar .block.associatedconstant");
let sidebarTraitList = document.querySelector(".sidebar .block.trait-implementation");
// @ts-expect-error
for (const impList of imp[window.currentCrate]) {
const types = impList.slice(2);
const text = impList[0];
const isTrait = impList[1] !== 0;
const traitName = impList[1];
if (types.indexOf(selfPath) === -1) {
continue;
}
let outputList = isTrait ? trait_implementations : implementations;
if (outputList === null) {
const outputListName = isTrait ? "Trait Implementations" : "Implementations";
const outputListId = isTrait ?
"trait-implementations-list" :
"implementations-list";
const outputListHeaderId = isTrait ? "trait-implementations" : "implementations";
const outputListHeader = document.createElement("h2");
outputListHeader.id = outputListHeaderId;
outputListHeader.innerText = outputListName;
outputList = document.createElement("div");
outputList.id = outputListId;
if (isTrait) {
const link = document.createElement("a");
link.href = `#${outputListHeaderId}`;
link.innerText = "Trait Implementations";
const h = document.createElement("h3");
h.appendChild(link);
trait_implementations = outputList;
trait_implementations_header = outputListHeader;
// @ts-expect-error
sidebarSection.appendChild(h);
sidebarTraitList = document.createElement("ul");
sidebarTraitList.className = "block trait-implementation";
// @ts-expect-error
sidebarSection.appendChild(sidebarTraitList);
// @ts-expect-error
mainContent.appendChild(outputListHeader);
// @ts-expect-error
mainContent.appendChild(outputList);
} else {
implementations = outputList;
if (trait_implementations) {
// @ts-expect-error
mainContent.insertBefore(outputListHeader, trait_implementations_header);
// @ts-expect-error
mainContent.insertBefore(outputList, trait_implementations_header);
} else {
const mainContent = document.querySelector("#main-content");
// @ts-expect-error
mainContent.appendChild(outputListHeader);
// @ts-expect-error
mainContent.appendChild(outputList);
}
}
}
const template = document.createElement("template");
template.innerHTML = text;
onEachLazy(template.content.querySelectorAll("a"), elem => {
const href = elem.getAttribute("href");
if (href && !href.startsWith("#") && !/^(?:[a-z+]+:)?\/\//.test(href)) {
elem.setAttribute("href", window.rootPath + href);
}
});
onEachLazy(template.content.querySelectorAll("[id]"), el => {
let i = 0;
if (idMap.has(el.id)) {
i = idMap.get(el.id);
} else if (document.getElementById(el.id)) {
i = 1;
while (document.getElementById(`${el.id}-${2 * i}`)) {
i = 2 * i;
}
while (document.getElementById(`${el.id}-${i}`)) {
i += 1;
}
}
if (i !== 0) {
const oldHref = `#${el.id}`;
const newHref = `#${el.id}-${i}`;
el.id = `${el.id}-${i}`;
onEachLazy(template.content.querySelectorAll("a[href]"), link => {
if (link.getAttribute("href") === oldHref) {
link.href = newHref;
}
});
}
idMap.set(el.id, i + 1);
});
const templateAssocItems = template.content.querySelectorAll("section.tymethod, " +
"section.method, section.associatedtype, section.associatedconstant");
if (isTrait) {
const li = document.createElement("li");
const a = document.createElement("a");
// @ts-expect-error
a.href = `#${template.content.querySelector(".impl").id}`;
a.textContent = traitName;
li.appendChild(a);
// @ts-expect-error
sidebarTraitList.append(li);
} else {
onEachLazy(templateAssocItems, item => {
let block = hasClass(item, "associatedtype") ? associatedTypes : (
hasClass(item, "associatedconstant") ? associatedConstants : (
methods));
if (!block) {
const blockTitle = hasClass(item, "associatedtype") ? "Associated Types" : (
hasClass(item, "associatedconstant") ? "Associated Constants" : (
"Methods"));
const blockClass = hasClass(item, "associatedtype") ? "associatedtype" : (
hasClass(item, "associatedconstant") ? "associatedconstant" : (
"method"));
const blockHeader = document.createElement("h3");
const blockLink = document.createElement("a");
blockLink.href = "#implementations";
blockLink.innerText = blockTitle;
blockHeader.appendChild(blockLink);
block = document.createElement("ul");
block.className = `block ${blockClass}`;
const insertionReference = methods || sidebarTraitList;
if (insertionReference) {
const insertionReferenceH = insertionReference.previousElementSibling;
// @ts-expect-error
sidebarSection.insertBefore(blockHeader, insertionReferenceH);
// @ts-expect-error
sidebarSection.insertBefore(block, insertionReferenceH);
} else {
// @ts-expect-error
sidebarSection.appendChild(blockHeader);
// @ts-expect-error
sidebarSection.appendChild(block);
}
if (hasClass(item, "associatedtype")) {
associatedTypes = block;
} else if (hasClass(item, "associatedconstant")) {
associatedConstants = block;
} else {
methods = block;
}
}
const li = document.createElement("li");
const a = document.createElement("a");
a.innerText = item.id.split("-")[0].split(".")[1];
a.href = `#${item.id}`;
li.appendChild(a);
block.appendChild(li);
});
}
outputList.appendChild(template.content);
}
for (const list of [methods, associatedTypes, associatedConstants, sidebarTraitList]) {
if (!list) {
continue;
}
const newChildren = Array.prototype.slice.call(list.children);
newChildren.sort((a, b) => {
const aI = a.innerText;
const bI = b.innerText;
return aI < bI ? -1 :
aI > bI ? 1 :
0;
});
list.replaceChildren(...newChildren);
}
};
if (window.pending_type_impls) {
window.register_type_impls(window.pending_type_impls);
}
function addSidebarCrates() {
// @ts-expect-error
if (!window.ALL_CRATES) {
return;