db

Documentation

Index

• type Favorites
  • func (f Favorites) Delete(db *bolt.DB, key string) error
  • func (f Favorites) Insert(db *bolt.DB, key string) error
  • func (f Favorites) Read(db *bolt.DB) error
• type Feed
  • func (f *Feed) Compare(i *Feed) bool
  • func (f *Feed) FindNewItems(citems map[string]*Item) (map[string]*Item, error)
• type Feeds
  • func (f Feeds) AddItems(db *bolt.DB, url string, items Items) error
  • func (f Feeds) Delete(db *bolt.DB, url string) (map[string]bool, error)
  • func (f Feeds) Insert(db *bolt.DB, url string) ([]*gofeed.Item, error)
  • func (f Feeds) Read(db *bolt.DB) error
• type Item
  • func (q *Item) Compare(i *Item) bool
  • func (q *Item) DeleteFile(path string, feeds Feeds)
  • func (q *Item) Download(path string, feeds Feeds) error
  • func (q *Item) ExtPlay(bin string, args []string, path string, feeds Feeds) error
• type Items
  • func (f Items) Delete(db *bolt.DB, key string) error
  • func (f Items) Insert(db *bolt.DB, item *Item) (string, error)
  • func (f Items) ProcessInsert(db *bolt.DB, it *gofeed.Item, url string) (string, error)
  • func (f Items) Read(db *bolt.DB) error
  • func (f Items) ToggleFavorite(db *bolt.DB, key string) error
  • func (f Items) ToggleRead(db *bolt.DB, key string) error
• type Queue
  • func (f Queue) Delete(db *bolt.DB, key string) error
  • func (f Queue) Insert(db *bolt.DB, key string) error
  • func (f Queue) Read(db *bolt.DB) error
• type Storage
  • func ReadDB(path string) (*Storage, error)
  • func (s *Storage) CreateFeed(url string) error
  • func (s *Storage) DeleteFeed(url string) error
  • func (s *Storage) Favorite(key string) error
  • func (s *Storage) MarkRead(key string) (map[string]bool, error)
  • func (s *Storage) MarkUnread(key string) error
  • func (s *Storage) Unfavorite(key string) error
  • func (s *Storage) Update() (map[string]*Item, error)

Types

type Favorites

type Favorites map[string]bool

Favorites contains items that have been added to favorites

func (Favorites) Delete

func (f Favorites) Delete(db *bolt.DB, key string) error

Delete will remove a favorite item from the database

func (Favorites) Insert

func (f Favorites) Insert(db *bolt.DB, key string) error

Insert favorite item into database

func (Favorites) Read

func (f Favorites) Read(db *bolt.DB) error

Read will load the contents of the database into this structure

type Feed

type Feed struct {
	Title       string          `json:"title"`
	Description string          `json:"description"`
	UpdateURL   string          `json:"updateurl"`
	Link        string          `json:"link"`
	Items       map[string]bool `json:"items"`
}

Feed is the structure of the Feed from RSS that we care about. The Items contains the unique Location.

func (*Feed) Compare

func (f *Feed) Compare(i *Feed) bool

Compare will determine equality of strings

func (*Feed) FindNewItems

func (f *Feed) FindNewItems(citems map[string]*Item) (map[string]*Item, error)

FindNewItems will process the items under the feed and add return any new ones since last update

type Feeds

type Feeds map[string]*Feed

Feeds is a map of the UpdateURL to the Feed.

func (Feeds) AddItems

func (f Feeds) AddItems(db *bolt.DB, url string, items Items) error

AddItems will update the feeds map of items and unread count

func (Feeds) Delete

func (f Feeds) Delete(db *bolt.DB, url string) (map[string]bool, error)

Delete will remove a feed from the database

func (Feeds) Insert

func (f Feeds) Insert(db *bolt.DB, url string) ([]*gofeed.Item, error)

Insert feed into database by url

func (Feeds) Read

func (f Feeds) Read(db *bolt.DB) error

Read will load the contents of the database into this structure

type Item

type Item struct {
	FeedURL     string    `json:"feedurl"`
	Title       string    `json:"title"`
	Content     string    `json:"content"`
	Link        string    `json:"link"`
	Date        time.Time `json:"date"`
	Location    string    `json:"location"`
	Type        string    `json:"type"`
	Length      string    `json:"length"`
	Read        bool      `json:"read"`
	Favorite    bool      `json:"favorite"`
	PlaybackPOS int       `json:"playbackposition"`
}

Item is the structure of the Item from RSS that we care about.

func (*Item) Compare

func (q *Item) Compare(i *Item) bool

Compare will determine equality of dates

func (*Item) DeleteFile

func (q *Item) DeleteFile(path string, feeds Feeds)

DeleteFile will delete the item that has been downloaded, note if the item is favorited it will not be deleted

func (*Item) Download

func (q *Item) Download(path string, feeds Feeds) error

Download the item is it is a podcast

func (*Item) ExtPlay

func (q *Item) ExtPlay(bin string, args []string, path string, feeds Feeds) error

ExtPlay will play the item using an external program

type Items

type Items map[string]*Item

Items is a map of the Location to the Item

func (Items) Delete

func (f Items) Delete(db *bolt.DB, key string) error

Delete will remove a item from the database

func (Items) Insert

func (f Items) Insert(db *bolt.DB, item *Item) (string, error)

Insert will add the item to the database

func (Items) ProcessInsert

func (f Items) ProcessInsert(db *bolt.DB, it *gofeed.Item, url string) (string, error)

ProcessInsert will convert the feed and insert item into database

func (Items) Read

func (f Items) Read(db *bolt.DB) error

Read will load the contents of the database into this structure

func (Items) ToggleFavorite

func (f Items) ToggleFavorite(db *bolt.DB, key string) error

ToggleFavorite will update the favorite status

func (Items) ToggleRead

func (f Items) ToggleRead(db *bolt.DB, key string) error

ToggleRead will update the read status

type Queue

type Queue map[string]bool

Queue of the items to be played

func (Queue) Delete

func (f Queue) Delete(db *bolt.DB, key string) error

Delete will remove a queue item from the database

func (Queue) Insert

func (f Queue) Insert(db *bolt.DB, key string) error

Insert queue item into database

func (Queue) Read

func (f Queue) Read(db *bolt.DB) error

Read will load the contents of the database into this structure

type Storage

type Storage struct {
	Feeds     Feeds
	Items     Items
	Queue     Queue
	Favorites Favorites
	Path      string
}

Storage contains the main data needed to run the app.

func ReadDB

func ReadDB(path string) (*Storage, error)

ReadDB will grab all data from the database to use while running the app.

func (*Storage) CreateFeed

func (s *Storage) CreateFeed(url string) error

CreateFeed will collect the rss feed and process through the elements and add the relevant data elements to the database

func (*Storage) DeleteFeed

func (s *Storage) DeleteFeed(url string) error

DeleteFeed will delete the Feed, Items, and relevant items it the queue.

func (*Storage) Favorite

func (s *Storage) Favorite(key string) error

Favorite wil update the Storage to note that an item has been added to favorites.

func (*Storage) MarkRead

func (s *Storage) MarkRead(key string) (map[string]bool, error)

MarkRead wil update the Storage to note that an item has been read, remove the item from the list.

func (*Storage) MarkUnread

func (s *Storage) MarkUnread(key string) error

MarkUnread wil update the Storage to note that an item has been unread, add the item from the list.

func (*Storage) Unfavorite

func (s *Storage) Unfavorite(key string) error

Unfavorite wil update the Storage to note that an item has been removed from favorites.

func (*Storage) Update

func (s *Storage) Update() (map[string]*Item, error)

Update will check for rss updates