models

Documentation

Index

• func NewCard(rank Rank, suit Suit) (*card, error)
• func NewCommunityCards(cards ...Card) *communityCards
• func NewDealtCards(c ...Card) *dealtCards
• func NewDeck() *deck
• func NewHand(cards []Card) *hand
• type Card
• type CommunityCards
• type DealtCards
• type Deck
• type Hand
• type HandType
• type Rank
• type Suit

Functions

func NewCard

func NewCard(rank Rank, suit Suit) (*card, error)

func NewCommunityCards

func NewCommunityCards(cards ...Card) *communityCards

func NewDealtCards

func NewDealtCards(c ...Card) *dealtCards

func NewDeck

func NewDeck() *deck

func NewHand

func NewHand(cards []Card) *hand

Types

type Card

type Card interface {
	Equals(Card) bool
	EqualsRank(Card) bool
	EqualsSuit(Card) bool
	GetRank() Rank
	GetSuit() Suit
	GreaterThan(Card) bool
	LessThan(Card) bool
	RankDifference(Card) int
	String() string
	Valid() bool
}

type CommunityCards

type CommunityCards interface {
	Clone() CommunityCards
	GetAllCards() []Card
	GetOpenedCards() []Card
	GetUnopenedCards() []Card
	SetUnopenedCards(cards []Card)
}

type DealtCards

type DealtCards interface {
	GetCards() []Card
	SetUnknownDealtCards(...Card)
}

type Deck

type Deck interface {
	AddCards([]Card)
	Contains(Card) bool
	Burn()
	PopCardsFromTop(int) []Card
	RemoveCards([]Card)
}

type Hand

type Hand interface {
	Compare(Hand) int
	GetHandType() HandType
	GetTieBreakerCardsOrder() []Card
	SetHandType()
	String() string
}

type HandType

type HandType int

const (
	RoyalFlush HandType = iota
	StraightFlush
	FourOfAKind
	FullHouse
	Flush
	Straight
	ThreeOfAKind
	TwoPairs
	Pair
	HighCard
	Default
)

type Rank

type Rank string

type Suit

type Suit rune