feed

Documentation

Index

• type Feed
  • func (f *Feed) End()
  • func (f *Feed) GetTitle() string
  • func (f *Feed) Start(URL string) (chan *storage.RssEntry, error)
• type FeedInterface

Types

type Feed

type Feed struct {
	Title string
	URL   string
	// contains filtered or unexported fields
}

Feed implements the FeedInterface.

func (*Feed) End

func (f *Feed) End()

End terminates the feed.

func (*Feed) GetTitle

func (f *Feed) GetTitle() string

GetTitle does what you would expect.

func (*Feed) Start

func (f *Feed) Start(URL string) (chan *storage.RssEntry, error)

Start begins the feed. It will continue to retrieve items from the URL at an interval. Although no formal guarantees are made regarding duplicates, generally, it can be assumed that duplicates will not be sent on the pipe for a while.

type FeedInterface

type FeedInterface interface {
	// The channel returned from "Start" will never return duplicate entries.
	Start(URL string) (chan *storage.RssEntry, error)
	GetTitle() string
	End()
}

FeedInterface decouples the "RSS/Atom" interface from our implementation.