quotes

package

v1.0.1 Latest Latest Go to latest Published: Dec 18, 2019 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Package quotes implements a plugin to save and replay quotes.

This section is empty.

This section is empty.

func Register(b bot.Bot, f string)

Register registers the plugin with a bot.

type Quote struct {
	ID              int    `json:"-"` // ignore ID in JSON as it's the map key
	Added, By, Text string `json:",omitempty"`
}

A Quote represents a quote text, added by a nick at a given time.

func (q Quote) String() string

String formats a single quote.

type Quotes struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Quotes is the main structure to hold quotes in the plugin.

func NewQuotes() *Quotes

NewQuotes creates a new initialized Quotes.

func (q *Quotes) Add(by, text string) Quote

Add adds a new quote and return it.

func (q *Quotes) Delete(id int) bool

Delete removes a quote by its ID and returns whether it was there.

func (q *Quotes) Empty() bool

Empty returns whether there are no quotes yet.

func (q *Quotes) Get(id int) (Quote, bool)

Get obtains a quote by its ID, boolean if found.

func (q *Quotes) Random() Quote

Random picks a random quote (empty if no quotes).

func (q *Quotes) Search(term string) []Quote

Search finds quotes with simple contains or regexp.