feedreader

Documentation

Index

• type FeedItem
• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type Widget
  • func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget
  • func (widget *Widget) Fetch(feedURLs []string) ([]*FeedItem, error)
  • func (widget *Widget) Refresh()
  • func (widget *Widget) Render()

Types

type FeedItem

type FeedItem struct {
	// contains filtered or unexported fields
}

FeedItem represents an item returned from an RSS or Atom feed

type Settings

type Settings struct {
	// contains filtered or unexported fields
}

Settings defines the configuration properties for this module

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

NewSettingsFromYAML creates a new settings instance from a YAML config block

type Widget

type Widget struct {
	view.KeyboardWidget
	view.ScrollableWidget
	// contains filtered or unexported fields
}

Widget is the container for RSS and Atom data

func NewWidget

func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget

NewWidget creates a new instance of a widget

func (*Widget) Fetch

func (widget *Widget) Fetch(feedURLs []string) ([]*FeedItem, error)

Fetch retrieves RSS and Atom feed data

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh updates the data in the widget

func (*Widget) Render

func (widget *Widget) Render()

Render sets up the widget data for redrawing to the screen