Skip to content

Commit d68b5a4

Browse files
authored
Rollup merge of #107284 - notriddle:notriddle/plus, r=jsha
rustdoc: use smarter encoding for playground URL The old way would compress okay with DEFLATE, but this version makes uncompressed docs smaller, which matters for memory usage and stuff like `cargo doc`. Try it out: <https://play.rust-lang.org/?code=fn+main()+{%0Alet+mut+v+=+Vec::new();%0Av.push(1+/+1);%0Aprintln!(%22{}%22,+v[0]);%0A}> In local testing, this change shrinks sample pages by anywhere between 4.0% and 0.031% $ du -b after.dir/std/vec/struct.Vec.html before.dir/std/vec/struct.Vec.html 759235 after.dir/std/vec/struct.Vec.html 781842 before.dir/std/vec/struct.Vec.html 100*((759235-781842)/781842)=-2.8 $ du -b after.dir/std/num/struct.Wrapping.html before.dir/std/num/struct.Wrapping.html 3194173 after.dir/std/num/struct.Wrapping.html 3204351 before.dir/std/num/struct.Wrapping.html 100*((3194173-3204351)/3204351)=-0.031 $ du -b after.dir/std/keyword.match.html before.dir/std/keyword.match.html 8151 after.dir/std/keyword.match.html 8495 before.dir/std/keyword.match.html 100*((8151-8495)/8495)=-4.0 Gzipped tarball sizes seem shrunk, but not by much. du -s before.tar.gz after.tar.gz 69600 before.tar.gz 69480 after.tar.gz 100*((69480-69600)/69600)=-0.17
2 parents 5683915 + 51df99f commit d68b5a4

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

src/librustdoc/html/markdown.rs

+18-1
Original file line numberDiff line numberDiff line change
@@ -296,25 +296,42 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
296296
let channel = if test.contains("#![feature(") { "&amp;version=nightly" } else { "" };
297297

298298
// These characters don't need to be escaped in a URI.
299-
// FIXME: use a library function for percent encoding.
299+
// See https://url.spec.whatwg.org/#query-percent-encode-set
300+
// and https://url.spec.whatwg.org/#urlencoded-parsing
301+
// and https://url.spec.whatwg.org/#url-code-points
300302
fn dont_escape(c: u8) -> bool {
301303
(b'a' <= c && c <= b'z')
302304
|| (b'A' <= c && c <= b'Z')
303305
|| (b'0' <= c && c <= b'9')
304306
|| c == b'-'
305307
|| c == b'_'
306308
|| c == b'.'
309+
|| c == b','
307310
|| c == b'~'
308311
|| c == b'!'
309312
|| c == b'\''
310313
|| c == b'('
311314
|| c == b')'
312315
|| c == b'*'
316+
|| c == b'/'
317+
|| c == b';'
318+
|| c == b':'
319+
|| c == b'?'
320+
// As described in urlencoded-parsing, the
321+
// first `=` is the one that separates key from
322+
// value. Following `=`s are part of the value.
323+
|| c == b'='
313324
}
314325
let mut test_escaped = String::new();
315326
for b in test.bytes() {
316327
if dont_escape(b) {
317328
test_escaped.push(char::from(b));
329+
} else if b == b' ' {
330+
// URL queries are decoded with + replaced with SP
331+
test_escaped.push('+');
332+
} else if b == b'%' {
333+
test_escaped.push('%');
334+
test_escaped.push('%');
318335
} else {
319336
write!(test_escaped, "%{:02X}", b).unwrap();
320337
}

tests/rustdoc/playground-arg.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
pub fn dummy() {}
1111

1212
// ensure that `extern crate foo;` was inserted into code snips automatically:
13-
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://example.com/?code=%23!%5Ballow(unused)%5D%0Aextern%20crate%20r%23foo%3B%0Afn%20main()%20%7B%0Ause%20foo%3A%3Adummy%3B%0Adummy()%3B%0A%7D&edition=2015"]' "Run"
13+
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://example.com/?code=%23!%5Ballow(unused)%5D%0Aextern+crate+r%23foo;%0Afn+main()+%7B%0Ause+foo::dummy;%0Adummy();%0A%7D&edition=2015"]' "Run"

tests/rustdoc/playground.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@
2222
//! }
2323
//! ```
2424
25-
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0A%20%20%20%20println!(%22Hello%2C%20world!%22)%3B%0A%7D&edition=2015"]' "Run"
26-
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Aprintln!(%22Hello%2C%20world!%22)%3B%0A%7D&edition=2015"]' "Run"
27-
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(something)%5D%0A%0Afn%20main()%20%7B%0A%20%20%20%20println!(%22Hello%2C%20world!%22)%3B%0A%7D&version=nightly&edition=2015"]' "Run"
25+
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0Aprintln!(%22Hello,+world!%22);%0A%7D&edition=2015"]' "Run"
26+
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&edition=2015"]' "Run"
27+
// @matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(something)%5D%0A%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&version=nightly&edition=2015"]' "Run"

0 commit comments

Comments
 (0)