backend

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 5, 2023 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultCacheDuration = 24 * time.Hour

DefaultCacheDuration is the default duration for which an item is cached

View Source 
var DefaultCacheSize = 100

DefaultCacheSize is the default size of the cache

Functions

func DeleteItem 

func DeleteItem(itemType ItemType, key string) tea.Cmd

DeleteItem is a function to tell the main model that a new item needs to be removed from the list

func DownloadItem added in v1.1.0 

func DownloadItem(key string, index int) tea.Cmd

DownloadItem is a function to tell the main model that a new item needs to be downloaded

func NewItem 

func NewItem(itemType ItemType, newItem bool, itemPath []string, oldFields []string) tea.Cmd

NewItem is a function to tell the main model that a new item needs to be added to the list

Types

type Backend 

type Backend struct {
	Cache *Cache
	Rss   *rss.Rss
}

Backend uses a local cache to get all the feeds and their articles

func New 

func New(urlPath, cachePath string, resetCache bool) (Backend, error)

New creates a new Cache Backend

func (Backend) Close 

func (b Backend) Close() error

Close closes the backend

func (Backend) DownloadItem added in v1.1.0 

func (b Backend) DownloadItem(key string, index int) tea.Cmd

DownloadItem returns a tea.Cmd which downloads an item

func (Backend) FetchAllArticles added in v1.0.2 

func (b Backend) FetchAllArticles(_ string) tea.Cmd

FetchAllArticles returns a tea.Cmd which gets all the articles from the backend

func (Backend) FetchArticles 

func (b Backend) FetchArticles(feedName string) tea.Cmd

FetchArticles returns a tea.Cmd which gets the articles from the backend via a string key

func (Backend) FetchCategories 

func (b Backend) FetchCategories() tea.Cmd

FetchCategories returns a tea.Cmd which gets the category list from the backend

func (Backend) FetchDownloadedArticles added in v1.1.0 

func (b Backend) FetchDownloadedArticles(_ string) tea.Cmd

FetchDownloaded returns a tea.Cmd which gets all the downloaded articles from the backend

func (Backend) FetchFeeds 

func (b Backend) FetchFeeds(catName string) tea.Cmd

FetchFeeds returns a tea.Cmd which gets the feed list from the backend via a string key

type Cache 

type Cache struct {
	Content map[string]Item `json:"content"`
	// contains filtered or unexported fields
}

Cache is a basic cache to read and write gofeed.Items based on the URL

func (*Cache) AddToDownloaded added in v1.1.0 

func (c *Cache) AddToDownloaded(url string, index int) error

AddToDownloaded adds an item to the downloaded list

func (*Cache) GetAllArticles added in v1.0.1 

func (c *Cache) GetAllArticles(urls []string) []gofeed.Item

GetAllArticles returns an article list from the cache or fetches it from the internet if it is not cached and updates the cache, it also updates expired items and sorts the items by publish date

func (*Cache) GetArticle 

func (c *Cache) GetArticle(url string) ([]gofeed.Item, error)

GetArticle returns an article list from the cache or fetches it from the internet if it is not cached and updates the cache, it also updates expired items

func (*Cache) GetDownloaded added in v1.1.0 

func (c *Cache) GetDownloaded() []gofeed.Item

GetDownloaded returns a list of downloaded items

func (*Cache) Load 

func (c *Cache) Load() error

Load reads the cache from disk

func (*Cache) Save 

func (c *Cache) Save() error

Save writes the cache to disk

type DeleteItemMessage 

type DeleteItemMessage struct {
	Type ItemType
	Key  string
}

DeleteItemMessage is a message to tell the main model that a new item needs to be removed from the list

type DownloadItemMessage added in v1.1.0 

type DownloadItemMessage struct {
	Key   string
	Index int
}

DownloadItemMessage is a message to tell the main model that a new item needs to be downloaded

type FetchErrorMessage 

type FetchErrorMessage struct {
	Description string
	Err         error
}

FetchErrorMessage is a message that is sent when the fetching of the categories or feeds failed

type FetchSuccessMessage 

type FetchSuccessMessage struct {
	Items []list.Item
}

FetchSuccessMessage is a message that is sent when the fetching of the categories or feeds was successful

type Item 

type Item struct {
	Expire       time.Time     `json:"expire"`
	Items        []gofeed.Item `json:"items"`
	IsDownloaded bool          `json:"is_downloaded" default:"false" omitempty:"true"`
}

Item is an item in the cache

type ItemType 

type ItemType int

ItemType is the type of the added item 

const (
	Category ItemType = iota + 1
	Feed
)

type NewItemMessage 

type NewItemMessage struct {
	Type      ItemType
	New       bool
	Fields    []string
	ItemPath  []string
	OldFields []string
}

NewItemMessage is a message to tell the main model that a new item needs to be added to the list TODO: This should be more elegant

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.