stfu 0.1.0

Shut The Ferris Up - profanity filtering for Rust
Documentation 
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

//! # stfu: Shut The Ferris Up
//!
//! A general word filter for whatever use you want.
//!
//! # Usage
//! ```
//! use stfu::types::OwnedFilter;
//! use stfu::word_lists::category::SEXUAL_ANATOMY_SEXUAL_ACTS;
//! # fn main() {
//! let mut filter = OwnedFilter::default();
//! filter.add_slice(&SEXUAL_ANATOMY_SEXUAL_ACTS);
//! assert_eq!(filter.filter_string("hello world"), None);
//! assert_eq!(filter.filter_string("Mary had a little fucking lamb"), Some("fucking"));
//! # }
//! ```
//!
//! ```
//! use stfu::word_lists::category::SEXUAL_ANATOMY_SEXUAL_ACTS;
//! use stfu::filter::filter_string;
//! # fn main() {
//! assert_eq!(filter_string("hello world", &SEXUAL_ANATOMY_SEXUAL_ACTS), None);
//! assert_eq!(filter_string("Mary had a little fucking lamb", &SEXUAL_ANATOMY_SEXUAL_ACTS), Some("fucking"));
//! # }

#![deny(missing_docs)]
#![deny(clippy::missing_errors_doc)]
#![deny(clippy::missing_panics_doc)]
#![deny(clippy::missing_safety_doc)]

pub mod filter;
pub mod types;
pub mod word_lists;