strck_ident/lib.rs
1//! [![github-img]][github-url] [![crates-img]][crates-url] [![docs-img]][docs-url]
2//!
3//! [github-url]: https://github.com/QnnOkabayashi/strck_ident
4//! [crates-url]: https://crates.io/crates/strck_ident
5//! [docs-url]: crate
6//! [github-img]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
7//! [crates-img]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
8//! [docs-img]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K
9//!
10//! Checked owned and borrowed Unicode-based identifiers.
11//!
12//! # Overview
13//!
14//! [`strck`] is a crate for creating checked owned and borrowed strings with
15//! arbitrary invariants as the type level. This crate extends `strct` by providing
16//! [`Invariant`]s for [Unicode identifiers][unicode] and [Rust identifiers][rust].
17//! In the future, this crate may support identifiers for other languages as well.
18//!
19//! This crate re-exports [`Check`], [`Ck`], [`IntoCheck`], and [`IntoCk`] from
20//! `strck`, so other libraries only have to depend on this crate.
21//!
22//! # Feature flags
23//! * `rust`: Provide the [`rust`] module, containing an [`Invariant`] and type
24//! aliases to [`Ck`] and [`Check`] for Rust identifiers. Disabled by default.
25//!
26//! [`Invariant`]: strck::Invariant
27//! [`RustIdent`]: rust::RustIdent
28//! [`Ck`]: strck::Ck
29//! [`Check`]: strck::Check
30
31pub mod unicode;
32
33#[doc(no_inline)]
34pub use unicode::{Ident, IdentBuf};
35
36#[cfg(feature = "rust")]
37pub mod rust;
38
39#[doc(no_inline)]
40pub use strck::{Check, Ck, IntoCheck, IntoCk, Invariant};