ebook

Documentation

Index

• func AskForISBN() (string, error)
• func CleanCategory(category string) (string, error)
• func CleanDescription(desc string) string
• func CleanLanguage(language string) string
• func CleanType(typ string) (string, error)
• type Author
• type ISBN
  • func CleanISBN(full string) ([]ISBN, error)
  • func (i ISBN) Info() string
  • func (i ISBN) String() string
• type ISBNs
  • func (is *ISBNs) Add(i ISBN)
  • func (is *ISBNs) HasISBN13(isbn string) (bool, int)
• type Metadata
  • func (i *Metadata) Author() string
  • func (i *Metadata) Clean()
  • func (i *Metadata) MainSeries() SingleSeries
  • func (i *Metadata) Source() string
  • func (i *Metadata) String() string
  • func (i *Metadata) Title() string
• type Series
  • func (s *Series) AddFromString(candidate string) (bool, error)
  • func (s *Series) Has(seriesName string) (hasSeries bool, index int, position string)
  • func (s *Series) HasAny() bool
  • func (s Series) String() string
• type SingleSeries
  • func (s SingleSeries) String() string
• type Tag
• type Tags
  • func (t *Tags) Add(tags ...Tag) (added bool)
  • func (t *Tags) AddFromNames(tags ...string) bool
  • func (t *Tags) Clean()
  • func (t *Tags) Has(o Tag) (isIn bool, index int)
  • func (t *Tags) HasAny() bool
  • func (t *Tags) Remove(tags ...Tag) (removed bool)
  • func (t *Tags) RemoveFromNames(tags ...string) bool
  • func (t *Tags) String() string

Functions

func AskForISBN

func AskForISBN() (string, error)

AskForISBN when not found in epub

func CleanCategory

func CleanCategory(category string) (string, error)

func CleanDescription

func CleanDescription(desc string) string

func CleanLanguage

func CleanLanguage(language string) string

func CleanType

func CleanType(typ string) (string, error)

Types

type Author

type Author struct {
	Name string `json:"name" xml:"name"`
	Role string `json:"role" xml:"role"`
}

type ISBN

type ISBN struct {
	ISBN10   string
	ISBN13   string
	Location string
	Context  []string
}

func CleanISBN

func CleanISBN(full string) ([]ISBN, error)

CleanISBN from a string

func (ISBN) Info

func (i ISBN) Info() string

func (ISBN) String

func (i ISBN) String() string

type ISBNs

type ISBNs []ISBN

func (*ISBNs) Add

func (is *ISBNs) Add(i ISBN)

func (*ISBNs) HasISBN13

func (is *ISBNs) HasISBN13(isbn string) (bool, int)

type Metadata

type Metadata struct {
	BookTitle     string   `json:"title" xml:"title"`
	ImageURL      string   `json:"image_url" xml:"image_url"`
	NumPages      string   `json:"num_pages" xml:"num_pages"`
	Authors       []Author `json:"authors" xml:"authors>author"`
	ISBN          string   `json:"isbn" xml:"isbn13"`
	Format        string   `json:"format" xml:"format"`
	OriginalYear  string   `json:"year" xml:"work>original_publication_year"`
	EditionYear   string   `json:"edition_year" xml:"publication_year"`
	EditionInfo   string   `json:"edition_information" xml:"edition_information"`
	Description   string   `json:"description" xml:"description"`
	Series        Series   `json:"series" xml:"series_works>series_work"`
	AverageRating string   `json:"average_rating" xml:"average_rating"`
	Tags          Tags     `json:"tags" xml:"popular_shelves>shelf"`
	Category      string   `json:"category"`
	Type          string   `json:"type"`
	Genre         string   `json:"genre"`
	Language      string   `json:"language" xml:"language_code"`
	Publisher     string   `json:"publisher" xml:"publisher"`
}

Metadata contains all of the known book metadata.

func (*Metadata) Author

func (i *Metadata) Author() string

Author returns Metadata's main author.

func (*Metadata) Clean

func (i *Metadata) Clean()

Clean cleans up the Metadata

func (*Metadata) MainSeries

func (i *Metadata) MainSeries() SingleSeries

MainSeries return the main Series of Metadata.

func (*Metadata) Source

func (i *Metadata) Source() string

Source returns a representation of Metadata

func (*Metadata) String

func (i *Metadata) String() string

String returns a representation of Metadata

func (*Metadata) Title

func (i *Metadata) Title() string

Title returns Metadata's main title.

type Series

type Series []SingleSeries

Series can track a series and the position of an epub.

func (*Series) AddFromString

func (s *Series) AddFromString(candidate string) (bool, error)

AddFromString a series, checking for correct form.

func (*Series) Has

func (s *Series) Has(seriesName string) (hasSeries bool, index int, position string)

Has checks if epub is part of a series

func (*Series) HasAny

func (s *Series) HasAny() bool

HasAny checks if epub is part of any series

func (Series) String

func (s Series) String() string

String outputs a series info.

type SingleSeries

type SingleSeries struct {
	Name     string `json:"name" xml:"series>title"`
	Position string `json:"index" xml:"user_position"`
}

SingleSeries holds the name and index of a series a Book is part of.

func (SingleSeries) String

func (s SingleSeries) String() string

String outputs a single series info.

type Tag

type Tag struct {
	Name string `json:"name" xml:"name,attr"`
}

Tag holds the name of a tag.

type Tags

type Tags []Tag

Tags can track a book's Tags

func (*Tags) Add

func (t *Tags) Add(tags ...Tag) (added bool)

Add Tags to the list

func (*Tags) AddFromNames

func (t *Tags) AddFromNames(tags ...string) bool

AddFromNames Tags to the list, from []string

func (*Tags) Clean

func (t *Tags) Clean()

Clean a list of tags.

func (*Tags) Has

func (t *Tags) Has(o Tag) (isIn bool, index int)

Has finds out if a Tag is already in list.

func (*Tags) HasAny

func (t *Tags) HasAny() bool

HasAny checks if epub is part of any series

func (*Tags) Remove

func (t *Tags) Remove(tags ...Tag) (removed bool)

Remove Tags from the list

func (*Tags) RemoveFromNames

func (t *Tags) RemoveFromNames(tags ...string) bool

RemoveFromNames Tags to the list, from []string

func (*Tags) String

func (t *Tags) String() string

String give a string representation of Tags.