inpx

README

inpx

Inpx (book library archive) library for Go.

Documentation

Overview

Package inpx provides a set of methods to read .inpx files (book library index).

Index

• Constants
• Variables
• type Author
• type Book
• type File
  • func (fr File) Open() (io.ReadCloser, error)
• type Index
  • func Open(path string) (*Index, error)
  • func OpenWithStructure(path string, structure []int) (*Index, error)

Constants

const (
	FieldAuthor = iota
	FieldGenre
	FieldTitle
	FieldSeries
	FieldSeriesNum
	FieldFileName
	FieldFileSize
	FieldLibId
	FieldDeleted
	FieldExt
	FieldDate
	FieldLang
	FieldLibRate
	FieldKeywords
)

Known fields for inp files.

Variables

var DefaultStructure = []int{
	FieldAuthor, FieldGenre, FieldTitle, FieldSeries, FieldSeriesNum,
	FieldFileName, FieldFileSize, FieldLibId, FieldDeleted, FieldExt, FieldDate, FieldLang,
	FieldLibRate, FieldKeywords,
}

DefaultStructure is an inp file field order used by default.

Types

type Author

type Author struct {
	Name []string
}

Author describes an author.

type Book

type Book struct {
	Authors   []Author
	Genres    []string
	Title     string
	Series    string
	SeriesNum int
	File      File
	LibId     int
	Deleted   bool
	Date      time.Time
	Lang      string
}

Book describes a book in archive.

type File

type File struct {
	Name    string
	Ext     string
	Dir     string
	Archive string
	Size    int
}

File describes a book file in archive.

func (File) Open

func (fr File) Open() (io.ReadCloser, error)

Open opens a book file from archive.

type Index

type Index struct {
	Name     string
	Version  int
	Archives map[string][]Book
}

Index describes an inpx file information.

func Open

func Open(path string) (*Index, error)

Open reads whole library index from an inpx file.

func OpenWithStructure

func OpenWithStructure(path string, structure []int) (*Index, error)

OpenWithStructure reads whole library index from an inpx file using a provided field structure for individual inp files.