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

//! # twilight-mention
//!
//! [![discord badge][]][discord link] [![github badge][]][github link] [![license badge][]][license link] ![rust badge]
//!
//! `twilight-mention` is a utility crate for the Discord [`twilight-rs`]
//! ecosystem to mention its model types and parse those mentions.
//!
//! With this library, you can create mentions for various types, such as users,
//! emojis, roles, members, or channels.
//!
//! ## Examples
//!
//! Create a mention formatter for a user ID, and then format it in a message:
//!
//! ```rust
//! use twilight_mention::Mention;
//! use twilight_model::id::UserId;
//!
//! let user_id = UserId(123);
//! let message = format!("Hey there, {}!", user_id.mention());
//! ```
//!
//! [`twilight-rs`]: https://github.com/twilight-rs/twilight
//! [discord badge]: https://img.shields.io/discord/745809834183753828?color=%237289DA&label=discord%20server&logo=discord&style=for-the-badge
//! [discord link]: https://discord.gg/7jj8n7D
//! [github badge]: https://img.shields.io/badge/github-twilight-6f42c1.svg?style=for-the-badge&logo=github
//! [github link]: https://github.com/twilight-rs/twilight
//! [license badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=for-the-badge&logo=pastebin
//! [license link]: https://github.com/twilight-rs/twilight/blob/trunk/LICENSE.md
//! [rust badge]: https://img.shields.io/badge/rust-stable-93450a.svg?style=for-the-badge&logo=rust

#![deny(
    clippy::all,
    clippy::pedantic,
    future_incompatible,
    missing_docs,
    nonstandard_style,
    rust_2018_idioms,
    unsafe_code,
    unused,
    warnings
)]
#![allow(clippy::module_name_repetitions)]

pub mod fmt;

pub mod parse;

#[doc(no_inline)]
pub use fmt::{Mention, MentionFormat};

#[doc(no_inline)]
pub use parse::ParseMention;