stfu/
lib.rs

1//! # stfu: Shut The Ferris Up
2//!
3//! A general word filter for whatever use you want.
4//!
5//! # Usage
6//! ```
7//! use stfu::types::OwnedFilter;
8//! use stfu::word_lists::category::SEXUAL_ANATOMY_SEXUAL_ACTS;
9//! # fn main() {
10//! let mut filter = OwnedFilter::default();
11//! filter.add_slice(&SEXUAL_ANATOMY_SEXUAL_ACTS);
12//! assert_eq!(filter.filter_string("hello world"), None);
13//! assert_eq!(filter.filter_string("Mary had a little fucking lamb"), Some("fucking"));
14//! # }
15//! ```
16//!
17//! ```
18//! use stfu::word_lists::category::SEXUAL_ANATOMY_SEXUAL_ACTS;
19//! use stfu::filter::filter_string;
20//! # fn main() {
21//! assert_eq!(filter_string("hello world", &SEXUAL_ANATOMY_SEXUAL_ACTS), None);
22//! assert_eq!(filter_string("Mary had a little fucking lamb", &SEXUAL_ANATOMY_SEXUAL_ACTS), Some("fucking"));
23//! # }
24
25#![deny(missing_docs)]
26#![deny(clippy::missing_errors_doc)]
27#![deny(clippy::missing_panics_doc)]
28#![deny(clippy::missing_safety_doc)]
29
30pub mod filter;
31pub mod types;
32pub mod word_lists;