deck

Documentation

Index

• Variables
• type Deck
  • func New(opts ...Option) (*Deck, error)
  • func (d *Deck) Cards() []card.Card
  • func (d *Deck) Composition() string
  • func (d *Deck) Draw(n int) ([]card.Card, error)
  • func (d *Deck) ID() string
  • func (d *Deck) IsShuffled() bool
  • func (d *Deck) Remaining() int
  • func (d *Deck) Shuffle()
• type Option
  • func WithCodes(codes ...string) Option
  • func WithComposition(comp string) Option
  • func WithID(id string) Option
  • func WithShuffled(s bool) Option

Variables

var ErrNotEnoughCards = errors.New("not enough cards")

ErrNotEnoughCards is the error returned when there are not enough cards in the deck.

Types

type Deck

type Deck struct {
	// contains filtered or unexported fields
}

Deck represents a deck of cards.

func New

func New(opts ...Option) (*Deck, error)

New creates a new deck with the given options.

func (*Deck) Cards

func (d *Deck) Cards() []card.Card

Cards returns the cards in the deck.

func (*Deck) Composition

func (d *Deck) Composition() string

Composition returns the composition of the deck.

func (*Deck) Draw

func (d *Deck) Draw(n int) ([]card.Card, error)

Draw returns n number of cards from the deck.

func (*Deck) ID

func (d *Deck) ID() string

ID returns the id of the deck.

func (*Deck) IsShuffled

func (d *Deck) IsShuffled() bool

IsShuffled returns true if the deck is shuffled.

func (*Deck) Remaining

func (d *Deck) Remaining() int

Remaining returns the cards remaining in the deck.

func (*Deck) Shuffle

func (d *Deck) Shuffle()

Shuffle shuffles the cards randomly in the deck.

type Option

type Option func(d *Deck)

Option is a function that can be used to modify a deck.

func WithCodes

func WithCodes(codes ...string) Option

WithCodes returns an option that sets the card codes of the deck.

func WithComposition

func WithComposition(comp string) Option

WithComposition returns an option that sets the composition of the deck.

func WithID

func WithID(id string) Option

WithID returns an option that sets the id of the deck.

func WithShuffled

func WithShuffled(s bool) Option

WithShuffled returns an option that sets the shuffled state of the deck.