poetry

Documentation

Index

• type Line
• type Poem
  • func LoadPoem(filename string) (Poem, error)
  • func NewPoem() Poem
  • func (p Poem) NumLines() (count int)
  • func (p Poem) NumStanzas() int
  • func (p Poem) Stats() (numVowels, numConsonants, numPuncs int)
  • func (p Poem) String() string
• type Stanza
  • func (s Stanza) NumLines() int
  • func (s Stanza) String() string

Types

type Line

type Line string

Create some types of our own

type Poem

type Poem []Stanza

func LoadPoem

func LoadPoem(filename string) (Poem, error)

Load a poem from a file

func NewPoem

func NewPoem() Poem

Create an empty poem

func (Poem) NumLines

func (p Poem) NumLines() (count int)

Get the number of lines in a Poem

func (Poem) NumStanzas

func (p Poem) NumStanzas() int

Get the number of Stanzas in a poem

func (Poem) Stats

func (p Poem) Stats() (numVowels, numConsonants, numPuncs int)

Get the count of vowels and consonants from the poem

func (Poem) String

func (p Poem) String() string

set String() for poem to make it implement Stringer interface

type Stanza

type Stanza []Line

func (Stanza) NumLines

func (s Stanza) NumLines() int

Get the number of line in a Stanza

func (Stanza) String

func (s Stanza) String() string

Set String() for Stanza to make it implement Stringer interface