palindromeda 0.2.0

Palindrome number generator and checker
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
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

[![Crates.io][crates-io-badge]][crates-io-url]
[![Docs.rs][docs-badge]][docs-url]
[![MIT License][license-badge]][license-url]

[crates-io-url]: https://crates.io/crates/palindromeda

[crates-io-badge]: https://img.shields.io/crates/v/palindromeda.svg?style=for-the-badge&color=purple

[docs-url]: https://docs.rs/palindromeda/latest/palindromeda/

[docs-badge]: https://img.shields.io/badge/Docs-rs-purple.svg?style=for-the-badge&logo=docsdotrs

[license-url]: https://github.com/CaelusV/palindromeda/blob/master/LICENSE

[license-badge]: https://img.shields.io/badge/License-MIT-purple.svg?style=for-the-badge

# Palindrome generator and checker for numbers.
A palindrome is a letter, number or any other sequence that is the exact same forwards and backwards.
This crate is specifically for palindromic numbers.

## Checking for palindromes
If you want to check whether an **unsigned integer** is a palindrome,
use the `is_palindrome` function:
```rust
let pal1: u64 = 8008; // This is a palindrome.
println!("Is {pal1} a palindrome? {}", pal1.is_palindrome());

let pal2: u8 = 69; // This is NOT a palindrome.
println!("Is {pal2} a palindrome? {}", pal2.is_palindrome());
```
Output:
```text
Is 8008 a palindrome? true
Is 69 a palindrome? false
```

## Generating palindromes
Generating a palindrome is as easy as using either `Palindrome::le` or `Palindrome::ge`
for the nearest palindrome to your number:
```rust
let number1: u64 = 420; // This number is too high.
// Let's get a palindrome that's lower.
println!("Palindrome that's lower: {}", Palindrome::le(number1));

let number2: u64 = 1337;
// Let's get a palindrome that's higher.
println!("Palindrome that's higher: {}", Palindrome::ge(number2));
```
Output:
```text
Palindrome that's lower: 414
Palindrome that's higher: 1441
```
And if you want, you can go from palindrome to palindrome with the
`Palindrome::previous` and `Palindrome::next` functions.

## Iterating over palindromes
With `PalindromeIter` you can also iterate over a large swathe of palindromes.