     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
    86
    87

    // Copyright 2012-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.

    //! Determine if a `char` is a valid identifier for a parser and/or lexer according to
    //! [Unicode Standard Annex #31](http://www.unicode.org/reports/tr31/) rules.
    //!
    //! ```rust
    //! extern crate unicode_xid;
    //!
    //! use unicode_xid::UnicodeXID;
    //!
    //! fn main() {
    //!     let ch = 'a';
    //!     println!("Is {} a valid start of an identifier? {}", ch, UnicodeXID::is_xid_start(ch));
    //! }
    //! ```
    //!
    //! # features
    //!
    //! unicode-xid supports a `no_std` feature. This eliminates dependence
    //! on std, and instead uses equivalent functions from core.
    //!
    //! # crates.io
    //!
    //! You can use this package in your project by adding the following
    //! to your `Cargo.toml`:
    //!
    //! ```toml
    //! [dependencies]
    //! unicode-xid = "0.0.4"
    //! ```

    #![deny(missing_docs, unsafe_code)]
    #![doc(html_logo_url = "https://unicode-rs.github.io/unicode-rs_sm.png",
           html_favicon_url = "https://unicode-rs.github.io/unicode-rs_sm.png")]

    #![no_std]
    #![cfg_attr(feature = "bench", feature(test, unicode))]

    #[cfg(test)]
    #[macro_use]
    extern crate std;

    #[cfg(feature = "bench")]
    extern crate test;

    use tables::derived_property;
    pub use tables::UNICODE_VERSION;

    mod tables;

    #[cfg(test)]
    mod tests;

    /// Methods for determining if a character is a valid identifier character.
    pub trait UnicodeXID {
        /// Returns whether the specified character satisfies the 'XID_Start'
        /// Unicode property.
        ///
        /// 'XID_Start' is a Unicode Derived Property specified in
        /// [UAX #31](http://unicode.org/reports/tr31/#NFKC_Modifications),
        /// mostly similar to ID_Start but modified for closure under NFKx.
        fn is_xid_start(self) -> bool;

        /// Returns whether the specified `char` satisfies the 'XID_Continue'
        /// Unicode property.
        ///
        /// 'XID_Continue' is a Unicode Derived Property specified in
        /// [UAX #31](http://unicode.org/reports/tr31/#NFKC_Modifications),
        /// mostly similar to 'ID_Continue' but modified for closure under NFKx.
        fn is_xid_continue(self) -> bool;
    }

    impl UnicodeXID for char {
        #[inline]
        fn is_xid_start(self) -> bool { derived_property::XID_Start(self) }

        #[inline]
        fn is_xid_continue(self) -> bool { derived_property::XID_Continue(self) }
    }

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