small-card-deck 0.1.1

A simple card deck library
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

# Rust Card Deck Library

This Rust library provides types and functions for working with a standard deck of playing cards. It includes definitions for `Suit`, `Value`, `Card`, and `Deck` types, along with various methods for interacting with decks.

## Installation

```sh
cargo add small-card-deck
```

## Usage

```rust
use small-card-deck::{Deck, Suit, Value};

fn main() {
    // Create a new deck
    let mut deck = Deck::new();

    // Shuffle the deck
    deck.shuffle();

    // Peek at the top card
    if let Some(top_card) = deck.peek() {
        println!("Top card: {}", top_card);
    } else {
        println!("The deck is empty!");
    }
}
```

Types
Suit

Represents the suit of a playing card.
Variants:

    Hearts
    Diamonds
    Clubs
    Spades

Value

Represents the value of a playing card.
Variants:

    Ace
    Two
    Three
    Four
    Five
    Six
    Seven
    Eight
    Nine
    Ten
    Jack
    Queen
    King

Card

Represents a single playing card, consisting of a suit and a value.
Methods:

    new(suit: Suit, value: Value) -> Self: Creates a new Card instance.
    to_string() -> String: Converts the card to a string representation.

Deck

Represents a deck of playing cards.
Methods:

    new() -> Self: Creates a new Deck instance with a standard 52-card deck.
    shuffle(): Shuffles the cards in the deck.
    peek() -> Option<&Card>: Returns a reference to the top card of the deck.