metadata

package

v4.20.2 Latest Latest Go to latest Published: Mar 9, 2026 License: GPL-3.0 Imports: 28 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/svera/coreander

Links

Open Source Insights

Documentation ¶

Index ¶

func FmtDuration(d time.Duration) string
type EpubReader
- func NewEpubReader() EpubReader
- func (e EpubReader) Cover(documentFullPath string, coverMaxWidth int) ([]byte, error)
- func (e EpubReader) Metadata(filename string) (Metadata, error)
type Metadata
- func (m Metadata) ReadingTime(wordsPerMinute float64) string
type PdfReader
type Reader

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FmtDuration ¶ added in v4.15.0

func FmtDuration(d time.Duration) string

FmtDuration formats a duration as "Xd Yh Zm" or "Yh Zm" if less than 24 hours

Types ¶

type EpubReader ¶

type EpubReader struct {
	GetMetadataFromFile func(path string) (*epub.Information, error)
	GetPackageFromFile  func(path string) (*epub.PackageDocument, error)
}

func NewEpubReader ¶ added in v4.4.0

func NewEpubReader() EpubReader

func (EpubReader) Cover ¶

func (e EpubReader) Cover(documentFullPath string, coverMaxWidth int) ([]byte, error)

Cover parses the document looking for a cover image and returns it

func (EpubReader) Metadata ¶

func (e EpubReader) Metadata(filename string) (Metadata, error)

type Metadata ¶

type Metadata struct {
	Title         string
	Authors       []string
	Description   template.HTML
	Language      string
	Publication   precisiondate.PrecisionDate
	Words         float64
	Series        string
	SeriesIndex   float64
	Pages         float64
	Format        string
	Subjects      []string
	Illustrations int
}

func (Metadata) ReadingTime ¶

func (m Metadata) ReadingTime(wordsPerMinute float64) string

type PdfReader ¶

type PdfReader struct {
	Fs afero.Fs
}

func (PdfReader) Cover ¶

func (p PdfReader) Cover(documentFullPath string, coverMaxWidth int) ([]byte, error)

Cover parses the document looking for a cover image and returns it

func (PdfReader) Illustrations ¶ added in v4.20.0

func (p PdfReader) Illustrations(documentFullPath string, minMegapixels float64) (int, error)

Illustrations returns the number of distinct embedded images with pixel count >= minMegapixels.

func (PdfReader) Metadata ¶

func (p PdfReader) Metadata(file string) (Metadata, error)

type Reader ¶

type Reader interface {
	Metadata(file string) (Metadata, error)
	Cover(documentFullPath string, coverMaxWidth int) ([]byte, error)
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL