lyrics

Documentation

Overview

Package lyrics implements the Lyrics structure.

Index

• type Lyrics
  • func ForFile(file string) *Lyrics
  • func (l *Lyrics) Search(x time.Duration) int
  • func (l *Lyrics) Sort()

Types

type Lyrics

type Lyrics struct {
	Times []time.Duration
	Lines []string
}

Lyrics holds lyrics.

func ForFile

func ForFile(file string) *Lyrics

ForFile returns Lyrics the file in disk.

func (*Lyrics) Search

func (l *Lyrics) Search(x time.Duration) int

Search return the first index greater with time than x. The return value minus one is the last index less than or equal to x.

The lyrics must be sorted by time.

func (*Lyrics) Sort

func (l *Lyrics) Sort()

Sort sorts lines in ascending order.