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
//! # Palindrome
//!
//! Do you want to check if something is or contains a palindrome? Use this library!
//!
//! ## Examples
//!
//! If you want to check whether something is a palindrome:
//!
//! ```rust
//! extern crate palindrome;
//!
//! assert!(palindrome::is_palindrome("Wow!"));
//!
//! assert!(palindrome::is_palindrome("Are we not pure? “No sir!” Panama’s moody Noriega brags. “It is garbage!” Irony dooms a man; a prisoner up to new era."));
//! ```
//! Alternatively, if you want to check whether something contains a palindrome:
//!
//! ```rust
//! extern crate palindrome;
//!
//! assert!(palindrome::contains_palindrome("This contains a palindrome, wow!"));
//! assert!(!palindrome::contains_palindrome("Single characters like a are not palindromes for convenience"));
//! ```
//!
//! ## License
//!
//! Licensed under MIT
use Display;
/// Determines if a value is a palindrome
///
/// Returns true when the value is a palindrome, this can be a sentence or a single word.
///
/// # Examples
///
/// Is a palindrome:
/// ```rust
/// assert!(palindrome::is_palindrome("Ana."));
/// assert!(palindrome::is_palindrome("A car, a man, a maraca."));
/// ```
///
/// Is not a palindrome:
/// ```rust
/// assert!(!palindrome::is_palindrome("Driving. Toot toot."));
/// ```
/// While it contains a palindrome, it's not a palindrome by itself.
/// Use `contains_palindrome` to check if it contains a palindrome.
/// Determines if a value contains a palindrome.
///
/// Returns true when the value contains a palindrome, like a sentence containing a palindrome.
///
/// # Examples
///
/// Contains a palindrome:
/// ```rust
/// assert!(palindrome::contains_palindrome("Ana."));
/// assert!(palindrome::contains_palindrome("This contains a palindrome: Ana."));
/// ```
///
/// Does not contain a palindrome:
/// ```rust
/// assert!(!palindrome::contains_palindrome("While a is a palindrome, we exclude it for convenience."));
/// ```