     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

    // Copyright 2014-2015 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.

    use std::fmt;
    use std::iter::repeat;

    /// An error that occurred during parsing or compiling a regular expression.
    #[derive(Clone, PartialEq)]
    pub enum Error {
        /// A syntax error.
        Syntax(String),
        /// The compiled program exceeded the set size limit.
        /// The argument is the size limit imposed.
        CompiledTooBig(usize),
        /// Hints that destructuring should not be exhaustive.
        ///
        /// This enum may grow additional variants, so this makes sure clients
        /// don't count on exhaustive matching. (Otherwise, adding a new variant
        /// could break existing code.)
        #[doc(hidden)]
        __Nonexhaustive,
    }

    impl ::std::error::Error for Error {
        fn description(&self) -> &str {
            match *self {
                Error::Syntax(ref err) => err,
                Error::CompiledTooBig(_) => "compiled program too big",
                Error::__Nonexhaustive => unreachable!(),
            }
        }
    }

    impl fmt::Display for Error {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match *self {
                Error::Syntax(ref err) => err.fmt(f),
                Error::CompiledTooBig(limit) => {
                    write!(f, "Compiled regex exceeds size limit of {} bytes.",
                           limit)
                }
                Error::__Nonexhaustive => unreachable!(),
            }
        }
    }

    // We implement our own Debug implementation so that we show nicer syntax
    // errors when people use `Regex::new(...).unwrap()`. It's a little weird,
    // but the `Syntax` variant is already storing a `String` anyway, so we might
    // as well format it nicely.
    impl fmt::Debug for Error {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match *self {
                Error::Syntax(ref err) => {
                    let hr: String = repeat('~').take(79).collect();
                    writeln!(f, "Syntax(")?;
                    writeln!(f, "{}", hr)?;
                    writeln!(f, "{}", err)?;
                    writeln!(f, "{}", hr)?;
                    write!(f, ")")?;
                    Ok(())
                }
                Error::CompiledTooBig(limit) => {
                    f.debug_tuple("CompiledTooBig")
                        .field(&limit)
                        .finish()
                }
                Error::__Nonexhaustive => {
                    f.debug_tuple("__Nonexhaustive").finish()
                }
            }
        }
    }

# 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`)