dou_dizhu 0.2.0

Rust toolkit for the Chinese card game Dou Dizhu (斗地主)
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
60
61
62

# dou_dizhu

[![Crates.io](https://img.shields.io/crates/v/dou_dizhu)](https://crates.io/crates/dou_dizhu)
[![Documentation](https://img.shields.io/docsrs/dou_dizhu)](https://docs.rs/dou_dizhu)
[![License](https://img.shields.io/crates/l/dou_dizhu)](#license)

A Rust toolkit for the Chinese card game Dou Dizhu (斗地主).

This crate implements Dou Dizhu strictly following the [Pagat rules](https://www.pagat.com/climbing/doudizhu.html), though it uses different terminology.

## Features

- Hand representation
- Compile-time and runtime validation
- All standard Dou Dizhu play kinds (solo, pair, trio, chain, airplane, rocket, etc.)
- Play kind recognition
- Play comparison
- Enumerating all plays of specified characteristics within a hand

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
dou_dizhu = "0.2"
```

Then:

```rust
use dou_dizhu::*;

fn main() {
    // Construct a play
    let airplane_with_solos = play!(const {
        Queen: 3,
        King: 3,
        Three,
        Four,
    })
    .unwrap();

    // Count how many stronger plays of the same kind exist in a full deck
    assert_eq!(
        Hand::FULL_DECK
            .plays(airplane_with_solos.kind())
            .filter(|p| p > &airplane_with_solos)
            .count(),
        77,
    );
}
```

## License

Licensed under either of:

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)

at your option.