clippings

Documentation

Overview

Package clippings provides a Reader for the Kindle's clipping format.

Index

• type Clipping
  • func Filter(items []Clipping, onlyType string) []Clipping
• type Range
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read() (clipping Clipping, err error)
  • func (r *Reader) ReadAll() (clippings []Clipping, err error)

Types

type Clipping

type Clipping struct {
	Title    string
	Author   string
	Type     string
	Page     *int   `json:",omitempty"`
	Location *Range `json:",omitempty"`
	Datetime time.Time
	Content  string
}

func Filter

func Filter(items []Clipping, onlyType string) []Clipping

type Range

type Range struct {
	From, To int
}

type Reader

type Reader struct {
	*bufio.Reader
}

func NewReader

func NewReader(r io.Reader) *Reader

func (*Reader) Read

func (r *Reader) Read() (clipping Clipping, err error)

func (*Reader) ReadAll

func (r *Reader) ReadAll() (clippings []Clipping, err error)