ebook

Documentation

Index

• func AskForISBN() (string, error)
• func CleanCategory(category string) (string, error)
• func CleanDescription(desc string) string
• func CleanISBN(full string) (string, error)
• func CleanLanguage(language string) string
• func CleanType(typ string) (string, error)
• type Metadata
• 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 CleanISBN

func CleanISBN(full string) (string, error)

CleanISBN from a string

func CleanLanguage

func CleanLanguage(language string) string

func CleanType

func CleanType(typ string) (string, error)

Types

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       []string `json:"authors" xml:"authors>author>name"`
	ISBN          string   `json:"isbn" xml:"isbn13"`
	OriginalYear  string   `json:"year" xml:"work>original_publication_year"`
	EditionYear   string   `json:"edition_year" xml:"publication_year"`
	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.

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.