     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

    #[cfg(feature = "suggestions")]
    use strsim;

    use fmt::Format;

    /// Produces a string from a given list of possible values which is similar to
    /// the passed in value `v` with a certain confidence.
    /// Thus in a list of possible values like ["foo", "bar"], the value "fop" will yield
    /// `Some("foo")`, whereas "blark" would yield `None`.
    #[cfg(feature = "suggestions")]
    #[cfg_attr(feature = "lints", allow(needless_lifetimes))]
    pub fn did_you_mean<'a, T, I>(v: &str, possible_values: I) -> Option<&'a str>
        where T: AsRef<str> + 'a,
              I: IntoIterator<Item = &'a T>
    {

        let mut candidate: Option<(f64, &str)> = None;
        for pv in possible_values.into_iter() {
            let confidence = strsim::jaro_winkler(v, pv.as_ref());
            if confidence > 0.8 &&
               (candidate.is_none() || (candidate.as_ref().unwrap().0 < confidence)) {
                candidate = Some((confidence, pv.as_ref()));
            }
        }
        match candidate {
            None => None,
            Some((_, candidate)) => Some(candidate),
        }
    }

    #[cfg(not(feature = "suggestions"))]
    pub fn did_you_mean<'a, T, I>(_: &str, _: I) -> Option<&'a str>
        where T: AsRef<str> + 'a,
              I: IntoIterator<Item = &'a T>
    {
        None
    }

    /// Returns a suffix that can be empty, or is the standard 'did you mean phrase
    #[cfg_attr(feature = "lints", allow(needless_lifetimes))]
    pub fn did_you_mean_suffix<'z, T, I>(arg: &str,
                                     values: I,
                                     style: DidYouMeanMessageStyle)
                                     -> (String, Option<&'z str>)
        where T: AsRef<str> + 'z,
              I: IntoIterator<Item = &'z T>
    {
        match did_you_mean(arg, values) {
            Some(candidate) => {
                let mut suffix = "\n\tDid you mean ".to_owned();
                match style {
                    DidYouMeanMessageStyle::LongFlag =>
                        suffix.push_str(&*format!("{}", Format::Good("--"))),
                    DidYouMeanMessageStyle::EnumValue => suffix.push('\''),
                }
                suffix.push_str(&Format::Good(candidate).to_string()[..]);
                if let DidYouMeanMessageStyle::EnumValue = style {
                    suffix.push('\'');
                }
                suffix.push_str(" ?");
                (suffix, Some(candidate))
            }
            None => (String::new(), None),
        }
    }

    /// A helper to determine message formatting
    pub enum DidYouMeanMessageStyle {
        /// Suggested value is a long flag
        LongFlag,
        /// Suggested value is one of various possible values
        EnumValue,
    }

    #[cfg(all(test, features = "suggestions"))]
    mod test {
        use super::*;

        #[test]
        fn did_you_mean_possible_values() {
            let p_vals = ["test", "possible", "values"];
            assert_eq!(did_you_mean("tst", p_vals.iter()), Some("test"));
            assert!(did_you_mean("hahaahahah", p_vals.iter()).is_none());
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

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