quotes

package

v0.0.0-...-3f4038a Latest Latest Go to latest Published: May 26, 2021 License: BSD-3-Clause Imports: 5 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.

This section is empty.

This section is empty.

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

DB is a quote database.

func Open(path string) (*DB, error)

Open opens the database file at path and returns a DB or an error.

func (d *DB) Close() error

func (d *DB) Create(q *Quote) error

Create takes a quote and saves it to the database, using the author name as the key. If the author already exists, Create returns an error.

func (d *DB) Get(author string) (*Quote, error)

Get takes an author name and retrieves the corresponding quote from the DB.

func (d *DB) List() ([]*Quote, error)

List lists all records in the DB.

type Quote struct {
	Author string `json:"author"`
	Text   string `json:"text"`
	Source string `json:"source,omitempty"`
}

Quote represents a quote, inlcuding its author and an optional source. The ID is a unique key.

func (q *Quote) Deserialize(b []byte) error

Deserialize takes a byte slice that contains a gob-encoded quote and turns it back into a Quote.

func (q Quote) Serialize() ([]byte, error)

Serialize returns a gob encoding of quote q.

func (q *Quote) String() string

String implements the stringer interface. A Quote can now be used everywhere a string is expected.