feed

Documentation

Index

• type Descriptor
• type Feed
  • func Create(parsedFeed *config.Feed, global config.GlobalOptions) (*Feed, error)
  • func (feed *Feed) Context() http.Context
  • func (feed *Feed) Descriptor() Descriptor
  • func (feed *Feed) FetchSuccessful() bool
  • func (feed *Feed) Filter(filter FilterFunc)
  • func (feed *Feed) Messages() (msg.Messages, error)
  • func (feed *Feed) NeedsUpdate(updateTime time.Time) bool
  • func (feed *Feed) Parse() error
  • func (feed *Feed) SetExtID(extID FeedID)
• type FeedID
• type FilterFunc
• type Item
  • func (item *Item) AddReason(reason string)
  • func (item *Item) Creator() string
  • func (item *Item) Date() string
  • func (item *Item) DateParsed() *time.Time
  • func (item *Item) FeedLink() string
  • func (item *Item) Id() string
• type ItemID

Types

type Descriptor

type Descriptor struct {
	Name string
	Url  string
}

type Feed

type Feed struct {
	*config.Feed

	Global config.GlobalOptions
	// contains filtered or unexported fields
}

func Create

func Create(parsedFeed *config.Feed, global config.GlobalOptions) (*Feed, error)

func (*Feed) Context

func (feed *Feed) Context() http.Context

func (*Feed) Descriptor

func (feed *Feed) Descriptor() Descriptor

func (*Feed) FetchSuccessful

func (feed *Feed) FetchSuccessful() bool

func (*Feed) Filter

func (feed *Feed) Filter(filter FilterFunc)

func (*Feed) Messages

func (feed *Feed) Messages() (msg.Messages, error)

func (*Feed) NeedsUpdate

func (feed *Feed) NeedsUpdate(updateTime time.Time) bool

func (*Feed) Parse

func (feed *Feed) Parse() error

func (*Feed) SetExtID

func (feed *Feed) SetExtID(extID FeedID)

type FeedID

type FeedID interface {
	String() string
}

type FilterFunc

type FilterFunc func(items []Item, ignHash, alwaysNew bool) []Item

type Item

type Item struct {
	*gofeed.Item              // access fields implicitly
	Feed         *gofeed.Feed // named explicitly to not shadow common fields with Item

	Body       string
	TextBody   string
	UpdateOnly bool
	ID         ItemID
	// contains filtered or unexported fields
}

func (*Item) AddReason

func (item *Item) AddReason(reason string)

func (*Item) Creator

func (item *Item) Creator() string

Creator returns the name of the creating authors (comma separated).

func (*Item) Date

func (item *Item) Date() string

func (*Item) DateParsed

func (item *Item) DateParsed() *time.Time

func (*Item) FeedLink

func (item *Item) FeedLink() string

func (*Item) Id

func (item *Item) Id() string

type ItemID

type ItemID uuid.UUID