option-like 0.1.2

Create your own Option-like enum
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
59

<!-- DO NOT EDIT -->
<!-- This file is automatically generated by README.ts. -->
<!-- Edit README.ts if you want to make changes. -->

# Create your own Option-like enum

[![Build](https://github.com/DenisGorbachev/option-like/actions/workflows/ci.yml/badge.svg)](https://github.com/DenisGorbachev/option-like)
[![Documentation](https://docs.rs/option-like/badge.svg)](https://docs.rs/option-like)

Create your own enum type that behaves like Rust’s `Option` but with custom names.

## Example

```rust
use option_like::option_like;

option_like!(
    #[derive(Debug, PartialEq)]
    pub enum Cached<T> {
        Hit(T),
        Miss,
    }

    is_some => is_hit
    is_none => is_miss
);

// Create instances
let c1 = Cached::<u32>::Hit(42);
let c2 = Cached::<u32>::Miss;

// Boolean tests
assert!(c1.is_hit());
assert!(c2.is_miss());

// Convert to Option
assert_eq!(Option::<u32>::from(c1), Some(42));
assert_eq!(Option::<u32>::from(c2), None);

// Convert from Option
assert_eq!(Cached::<u32>::from(Some(42)), Cached::Hit(42));
assert_eq!(Cached::<u32>::from(None), Cached::Miss);
```

## Installation

```shell
cargo add option-like
```

## Gratitude

Like the project? [⭐ Star this repo](https://github.com/DenisGorbachev/option-like) on GitHub!

## License

[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.