Explain the order of the enumeration items

Simply a micro-optimization to reduce code size and to open up
inlining opportunities.

diff --git a/src/libcore/char.rs b/src/libcore/char.rs
index 38337c7493eefba1ed011dbc609559e1f386e94d..d80b456181ae475d8e53651b30b2aefab89a38a5 100644 (file)
--- a/src/libcore/char.rs
+++ b/src/libcore/char.rs
@@ -411,6 +411,9 @@ pub struct EscapeUnicode {
     hex_digit_idx: usize,
 }
 
+// The enum values are ordered so that their representation is the
+// same as the remaining length (besides the hexadecimal digits). This
+// likely makes `len()` a single load from memory) and inline-worth.
 #[derive(Clone, Debug)]
 enum EscapeUnicodeState {
     Done,