web

README

Generic types and helpers for sancus web libraries

go get go.sancus.dev/web

See also

• https://go.sancus.dev/mix
• https://go.sancus.dev/cms
• https://go.sancus.dev/file2go
• https://go.sancus.dev/middleware

Documentation

Index

• type ChangeFrequency
  • func (f ChangeFrequency) String() string
• type Error
• type ErrorHandlerFunc
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) TryServeHTTP(w http.ResponseWriter, r *http.Request) error
• type MiddlewareHandler
• type MiddlewareHandlerFunc
  • func (f MiddlewareHandlerFunc) Middleware(next http.Handler) http.Handler
• type PageInfoCanonical
• type PageInfoChangeFrequency
• type PageInfoHandler
• type PageInfoLanguage
• type PageInfoLastModified
• type PageInfoLocation
• type PageInfoMethods
• type PageInfoMimeType
• type PageInfoPriority
• type RouterPageInfo

Types

type ChangeFrequency

type ChangeFrequency int

ChangeFrequency tells how frequently the page is likely to change

const (
	ChangeFrequencyUnknown ChangeFrequency = iota
	ChangeFrequencyNever
	ChangeFrequencyAlways
	ChangeFrequencyHourly
	ChangeFrequencyDaily
	ChangeFrequencyWeekly
	ChangeFrequencyMonthly
	ChangeFrequencyYearly
)

func (ChangeFrequency) String

func (f ChangeFrequency) String() string

type Error

type Error interface {
	Error() string
	Status() int
}

type ErrorHandlerFunc

type ErrorHandlerFunc func(http.ResponseWriter, *http.Request, error)

type Handler

type Handler interface {
	TryServeHTTP(http.ResponseWriter, *http.Request) error
}

type HandlerFunc

type HandlerFunc func(http.ResponseWriter, *http.Request) error

func (HandlerFunc) TryServeHTTP

func (f HandlerFunc) TryServeHTTP(w http.ResponseWriter, r *http.Request) error

type MiddlewareHandler

type MiddlewareHandler interface {
	Middleware(http.Handler) http.Handler
}

type MiddlewareHandlerFunc

type MiddlewareHandlerFunc func(http.Handler) http.Handler

func (MiddlewareHandlerFunc) Middleware

func (f MiddlewareHandlerFunc) Middleware(next http.Handler) http.Handler

type PageInfoCanonical

type PageInfoCanonical interface {
	Canonical() string
}

PageInfo can tell the recommended Path to access this resource

type PageInfoChangeFrequency

type PageInfoChangeFrequency interface {
	ChangeFrequency() string
}

PageInfo can tell how frequencly the page is likely to change

type PageInfoHandler

type PageInfoHandler interface {
	Handler() http.Handler
}

PageInfo can tell what handler to use to request the resource

type PageInfoLanguage

type PageInfoLanguage interface {
	Language() []string
}

PageInfo can tell the languages supported by the resource

type PageInfoLastModified

type PageInfoLastModified interface {
	LastModified() time.Time
}

PageInfo can tell when the package was last modified

type PageInfoLocation

type PageInfoLocation interface {
	Location() string
}

PageInfo can tell what Path was requested

type PageInfoMethods

type PageInfoMethods interface {
	Method() []string
}

PageInfo can tell the supported methods supported by the resource

type PageInfoMimeType

type PageInfoMimeType interface {
	MimeType() []string
}

PageInfo can tell the mime-types supported by the resource

type PageInfoPriority

type PageInfoPriority interface {
	Priority() float32
}

PageInfo can tell the relevance of this resource

type RouterPageInfo

type RouterPageInfo interface {
	PageInfo(*http.Request) (interface{}, bool)
}

Router can check for the existance of the requested resource