catalog

package

v0.0.0-...-60192f8 Latest Latest Go to latest Published: Apr 26, 2024 License: AGPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

codeberg.org/readeck/readeck

Links

Open Source Insights

Documentation ¶

Overview ¶

Package catalog provides type to create an OPDS catalog of entries.

Index ¶

func WithBookEntry(id uuid.UUID, title string, href string, issued, published, updated time.Time, ...) func(*opds.Feed)
func WithFeedType(t string) func(*opds.Feed)
func WithLink(t, rel, href string) func(*opds.Feed)
func WithNavEntry(title string, updated time.Time, href string, options ...func(*opds.Entry)) func(*opds.Feed)
func WithTitle(title string) func(*opds.Feed)
func WithURL(href string) func(*opds.Feed)
func WithUpdated(t time.Time) func(*opds.Feed)
type Catalog
- func New(srv *server.Server, r *http.Request, options ...func(*opds.Feed)) *Catalog
- func (c *Catalog) Render(w http.ResponseWriter, r *http.Request) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WithBookEntry ¶

func WithBookEntry(
	id uuid.UUID, title string, href string,
	issued, published, updated time.Time,
	publisher string, language string, description string,
) func(*opds.Feed)

WithBookEntry adds a new book entry to the feed.

func WithFeedType ¶

func WithFeedType(t string) func(*opds.Feed)

WithFeedType sets the feed type.

func WithLink ¶

func WithLink(t, rel, href string) func(*opds.Feed)

WithLink adds a link entry to the feed.

func WithNavEntry ¶

func WithNavEntry(title string, updated time.Time, href string, options ...func(*opds.Entry)) func(*opds.Feed)

WithNavEntry adds a new navigation entry to the feed.

func WithTitle ¶

func WithTitle(title string) func(*opds.Feed)

WithTitle sets the feed's title.

func WithURL ¶

func WithURL(href string) func(*opds.Feed)

WithURL sets the "self" feed link entry.

func WithUpdated ¶

func WithUpdated(t time.Time) func(*opds.Feed)

WithUpdated sets the feed last update value.

Types ¶

type Catalog ¶

type Catalog struct {
	*opds.Feed
}

Catalog is a wraper around opds.Feed.

func New ¶

func New(srv *server.Server, r *http.Request, options ...func(*opds.Feed)) *Catalog

New creates a new catalog with some prepared information.

func (*Catalog) Render ¶

func (c *Catalog) Render(w http.ResponseWriter, r *http.Request) error

Render write the full catalog to a writer.

Source Files ¶

View all Source files

catalog.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL