opml

Documentation

Overview

Package opml implements functions capable of parsing opml files containing a list of feed subscriptions.

Index

• type Body
• type Head
• type Opml
  • func Load(path string) (doc Opml, err error)
  • func Read(r io.Reader) (doc Opml, err error)
  • func (doc Opml) Encode(w io.Writer) error
• type Outline

Types

type Body

type Body struct {
	Outline []Outline `xml:"outline"`
}

type Head

type Head struct {
	Title string `xml:"title"`
}

type Opml

type Opml struct {
	XMLName struct{} `xml:"opml"`
	Version string   `xml:"version,attr"`
	Head    Head     `xml:"head"`
	Body    Body     `xml:"body"`
}

func Load

func Load(path string) (doc Opml, err error)

Load parses the OPML file at the path.

func Read

func Read(r io.Reader) (doc Opml, err error)

Read parses an OPML document.

func (Opml) Encode

func (doc Opml) Encode(w io.Writer) error

Encode writes the OPML document out.

type Outline

type Outline struct {
	Type   string `xml:"type,attr,omitempty"`
	Text   string `xml:"text,attr,omitempty"`
	XMLURL string `xml:"xmlUrl,attr,omitempty"`

	// description is the top-level description element from the feed.
	Description string `xml:"description,attr,omitempty"`

	// htmlUrl is the top-level link element.
	HTMLURL string `xml:"htmlUrl,attr,omitempty"`

	// language is the value of the top-level language element.
	Language string `xml:"language,attr,omitempty"`

	// title is probably the same as text, it should not be omitted. title
	// contains the top-level title element from the feed.
	Title string `xml:"title,attr,omitempty"`
}