data

package

v0.0.0-...-760c826 Latest Latest Go to latest Published: Feb 13, 2018 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrEmptyDatabase = errors.New("Database is empty")

ErrEmptyDatabase is returned when an empty database is used.

View Source

var ErrMissingFortune = errors.New("Could not find fortune with provided ID")

ErrMissingFortune is returned when a fortune for the provided ID is not found.

func ComputeID(data string) string

ComputeID generates a SHA-based unique ID for a fortune.

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

Database is an in-memory container for fortunes.

func NewDatabase(fortunes []string) *Database

NewDatabase creates a fortune.Database from an array of fortunes.

func Parse(r io.Reader) (*Database, error)

Parse initializes a fortune.Database with the fortune data parsed from the provided io.Reader.

func (d *Database) Count() int

Count returns the number of fortunes in the database.

func (d *Database) Get(id string) (*Fortune, error)

Get returns a single fortune from the database.

func (d *Database) List() []*Fortune

List returns all fortunes in the database.

func (d *Database) Random() (string, error)

Random returns the ID of a random fortune in the database.

type Fortune struct {
	ID   string `json:"id"`
	Data string `json:"data"`
}

Fortune is a data structure representing a fortune.

func NewFortune(data string) Fortune

NewFortune instantiates a fortune.Fortune from the provided string.