modelfeed

Documentation

Index

• func FromPBInternalID(id *librarian.InternalID) model.InternalID
• func FromPBTime(t *timestamppb.Timestamp) *time.Time
• func ToPBTime(t *time.Time) *timestamppb.Timestamp
• type Converter
  • func NewConverter() Converter
• type ConverterImpl
  • func (c *ConverterImpl) FromPBFeed(source *v1.Feed) *Feed
  • func (c *ConverterImpl) FromPBFeedEnclosure(source *v1.FeedEnclosure) *Enclosure
  • func (c *ConverterImpl) FromPBFeedImage(source *v1.FeedImage) *Image
  • func (c *ConverterImpl) FromPBFeedItem(source *v1.FeedItem) *Item
  • func (c *ConverterImpl) FromPBFeedItemList(source []*v1.FeedItem) []*Item
  • func (c *ConverterImpl) ToPBFeed(source *Feed) *v1.Feed
  • func (c *ConverterImpl) ToPBFeedEnclosure(source *Enclosure) *v1.FeedEnclosure
  • func (c *ConverterImpl) ToPBFeedImage(source *Image) *v1.FeedImage
  • func (c *ConverterImpl) ToPBFeedInternalID(source Feed) v1.InternalID
  • func (c *ConverterImpl) ToPBFeedItem(source *Item) *v1.FeedItem
• type Enclosure
• type Feed
  • func (f Feed) Len() int
  • func (f Feed) Less(i, k int) bool
  • func (f Feed) Swap(i, k int)
• type Image
• type Item
• type Person

Functions

func FromPBInternalID

func FromPBInternalID(id *librarian.InternalID) model.InternalID

func FromPBTime

func FromPBTime(t *timestamppb.Timestamp) *time.Time

func ToPBTime

func ToPBTime(t *time.Time) *timestamppb.Timestamp

Types

type Converter

type Converter interface {
	// goverter:matchIgnoreCase
	// goverter:map . Id
	ToPBFeed(*Feed) *librarian.Feed
	// goverter:map ID Id
	ToPBFeedInternalID(Feed) librarian.InternalID
	// goverter:matchIgnoreCase
	// goverter:ignore Id
	// goverter:map UpdatedParsed | ToPBTime
	// goverter:map PublishedParsed | ToPBTime
	ToPBFeedItem(*Item) *librarian.FeedItem
	// goverter:matchIgnoreCase
	ToPBFeedImage(*Image) *librarian.FeedImage
	// goverter:matchIgnoreCase
	ToPBFeedEnclosure(*Enclosure) *librarian.FeedEnclosure

	// goverter:matchIgnoreCase
	// goverter:map Id ID
	// goverter:ignore FeedType
	// goverter:ignore FeedVersion
	FromPBFeed(*librarian.Feed) *Feed
	// goverter:matchIgnoreCase
	// goverter:map Id ID
	// goverter:map UpdatedParsed | FromPBTime
	// goverter:map PublishedParsed | FromPBTime
	// goverter:ignore DigestDescription
	// goverter:ignore DigestImages
	FromPBFeedItem(*librarian.FeedItem) *Item
	FromPBFeedItemList([]*librarian.FeedItem) []*Item
	// goverter:matchIgnoreCase
	FromPBFeedImage(*librarian.FeedImage) *Image
	// goverter:matchIgnoreCase
	FromPBFeedEnclosure(*librarian.FeedEnclosure) *Enclosure
}

goverter:converter goverter:extend FromPBInternalID

func NewConverter

func NewConverter() Converter

type ConverterImpl

type ConverterImpl struct{}

func (*ConverterImpl) FromPBFeed

func (c *ConverterImpl) FromPBFeed(source *v1.Feed) *Feed

func (*ConverterImpl) FromPBFeedEnclosure

func (c *ConverterImpl) FromPBFeedEnclosure(source *v1.FeedEnclosure) *Enclosure

func (*ConverterImpl) FromPBFeedImage

func (c *ConverterImpl) FromPBFeedImage(source *v1.FeedImage) *Image

func (*ConverterImpl) FromPBFeedItem

func (c *ConverterImpl) FromPBFeedItem(source *v1.FeedItem) *Item

func (*ConverterImpl) FromPBFeedItemList

func (c *ConverterImpl) FromPBFeedItemList(source []*v1.FeedItem) []*Item

func (*ConverterImpl) ToPBFeed

func (c *ConverterImpl) ToPBFeed(source *Feed) *v1.Feed

func (*ConverterImpl) ToPBFeedEnclosure

func (c *ConverterImpl) ToPBFeedEnclosure(source *Enclosure) *v1.FeedEnclosure

func (*ConverterImpl) ToPBFeedImage

func (c *ConverterImpl) ToPBFeedImage(source *Image) *v1.FeedImage

func (*ConverterImpl) ToPBFeedInternalID

func (c *ConverterImpl) ToPBFeedInternalID(source Feed) v1.InternalID

func (*ConverterImpl) ToPBFeedItem

func (c *ConverterImpl) ToPBFeedItem(source *Item) *v1.FeedItem

type Enclosure

type Enclosure struct {
	URL    string `json:"url,omitempty"`
	Length string `json:"length,omitempty"`
	Type   string `json:"type,omitempty"`
}

Enclosure is a file associated with a given Item.

type Feed

type Feed struct {
	ID          model.InternalID `json:"internal_id,omitempty"`
	Title       string           `json:"title,omitempty"`
	Description string           `json:"description,omitempty"`
	Link        string           `json:"link,omitempty"`
	Authors     []*Person        `json:"authors,omitempty"`
	Language    string           `json:"language,omitempty"`
	Image       *Image           `json:"image,omitempty"`
	Items       []*Item          `json:"items"`
	FeedType    string           `json:"feedType"`
	FeedVersion string           `json:"feedVersion"`
}

func (Feed) Len

func (f Feed) Len() int

Len returns the length of Items.

func (Feed) Less

func (f Feed) Less(i, k int) bool

Less compares PublishedParsed of Items[i], Items[k] and returns true if Items[i] is less than Items[k].

func (Feed) Swap

func (f Feed) Swap(i, k int)

Swap swaps Items[i] and Items[k].

type Image

type Image struct {
	URL   string `json:"url,omitempty"`
	Title string `json:"title,omitempty"`
}

Image is an image that is the artwork for a given feed or item.

type Item

type Item struct {
	ID                model.InternalID `json:"internal_id,omitempty"`
	Title             string           `json:"title,omitempty"`
	Description       string           `json:"description,omitempty"`
	Content           string           `json:"content,omitempty"`
	Link              string           `json:"link,omitempty"`
	Updated           string           `json:"updated,omitempty"`
	UpdatedParsed     *time.Time       `json:"updatedParsed,omitempty"`
	Published         string           `json:"published,omitempty"`
	PublishedParsed   *time.Time       `json:"publishedParsed,omitempty"`
	Authors           []*Person        `json:"authors,omitempty"`
	GUID              string           `json:"guid,omitempty"`
	Image             *Image           `json:"image,omitempty"`
	Enclosures        []*Enclosure     `json:"enclosures,omitempty"`
	PublishPlatform   string           `json:"publish_platform,omitempty"`
	ReadCount         int64            `json:"read_count,omitempty"`
	DigestDescription string           `json:"digest_description,omitempty"`
	DigestImages      []*Image         `json:"digest_images,omitempty"`
}

type Person

type Person struct {
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
}

Person is an individual specified in a feed (e.g. an author).