     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

    // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    #![allow(dead_code)]

    use fmt::{Formatter, Result, Write};
    use core::str::lossy::{Utf8Lossy, Utf8LossyChunk};

    pub fn debug_fmt_bytestring(slice: &[u8], f: &mut Formatter) -> Result {
        // Writes out a valid unicode string with the correct escape sequences
        fn write_str_escaped(f: &mut Formatter, s: &str) -> Result {
            for c in s.chars().flat_map(|c| c.escape_debug()) {
                f.write_char(c)?
            }
            Ok(())
        }

        f.write_str("\"")?;
        for Utf8LossyChunk { valid, broken } in Utf8Lossy::from_bytes(slice).chunks() {
            write_str_escaped(f, valid)?;
            for b in broken {
                write!(f, "\\x{:02X}", b)?;
            }
        }
        f.write_str("\"")
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use fmt::{Formatter, Result, Debug};

        #[test]
        fn smoke() {
            struct Helper<'a>(&'a [u8]);

            impl<'a> Debug for Helper<'a> {
                fn fmt(&self, f: &mut Formatter) -> Result {
                    debug_fmt_bytestring(self.0, f)
                }
            }

            let input =      b"\xF0hello,\tworld";
            let expected = r#""\xF0hello,\tworld""#;
            let output = format!("{:?}", Helper(input));

            assert!(output == expected);
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)