scout

Documentation

Index

• Constants
• func CurrentPath(r *http.Request) string
• func Path(root string, id string, suffixes ...string) string
• func Url(root string, id string, suffixes ...string) string
• type BranchType
  • func Branch() BranchType
• type ErrorPageType
• type Flash
• type FlashRenderer
• type Flashes
  • func NewFlash() *Flashes
  • func (f *Flashes) Add(msg string, ugency Urgency, expiry int)
  • func (f *Flashes) Clear(w http.ResponseWriter)
  • func (f *Flashes) Decode(encoded string) error
  • func (f *Flashes) Encode() ([]byte, error)
  • func (f *Flashes) Error(msg string)
  • func (f *Flashes) Info(msg string)
  • func (f *Flashes) Save(w http.ResponseWriter) error
  • func (f *Flashes) Success(msg string)
  • func (f *Flashes) Warning(msg string)
• type Handler
• type Layout
• type PathType
  • func (r *PathType) Delete(handler Handler) *PathType
  • func (r *PathType) Get(handler Handler) *PathType
  • func (r *PathType) Handle(method string, handler Handler) *PathType
  • func (r *PathType) Map(route PathType) *PathType
  • func (r *PathType) Patch(handler Handler) *PathType
  • func (r *PathType) Post(handler Handler) *PathType
  • func (r *PathType) Put(handler Handler) *PathType
• type Response
  • func Back() Response
  • func Content(content ...fido.Element) Response
  • func Error(err error) Response
  • func Redirect(url string) Response
  • func Respond() Response
  • func Success(msg string) Response
  • func (r Response) Back() Response
  • func (r Response) Content(content ...fido.Element) Response
  • func (r Response) Error(err error) Response
  • func (r Response) GetContent() []fido.Element
  • func (r Response) Header(key, value string) Response
  • func (r Response) Info(msg string, expiry ...int) Response
  • func (r Response) Notify(msg string, urgency Urgency, expiry ...int) Response
  • func (r Response) PushUrl(url string) Response
  • func (r Response) Redirect(url string) Response
  • func (r Response) ReplaceUrl(url string) Response
  • func (r Response) Success(msg string, expiry ...int) Response
  • func (r Response) Warning(msg string, expiry ...int) Response
• type Router
  • func New(mux *http.ServeMux, layout Layout, flashRenderer FlashRenderer) *Router
  • func (router *Router) Handle(pattern string, handler func(http.ResponseWriter, *http.Request))
  • func (router *Router) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
  • func (router *Router) Path(path string) *PathType
  • func (router *Router) Verbose(verbose bool)
• type Urgency

Constants

const FlashCookieName = "flash"

Functions

func CurrentPath

func CurrentPath(r *http.Request) string

func Path

func Path(root string, id string, suffixes ...string) string

func Url

func Url(root string, id string, suffixes ...string) string

Types

type BranchType

type BranchType map[string]*PathType

func Branch

func Branch() BranchType

type ErrorPageType

type ErrorPageType func(err Response) fido.Element

type Flash

type Flash struct {
	Id      int64
	Message string
	Urgency Urgency
	Expiry  int
}

type FlashRenderer

type FlashRenderer func(flash Flash, i int) fido.Element

type Flashes

type Flashes []Flash

func NewFlash

func NewFlash() *Flashes

func (*Flashes) Add

func (f *Flashes) Add(msg string, ugency Urgency, expiry int)

func (*Flashes) Clear

func (f *Flashes) Clear(w http.ResponseWriter)

func (*Flashes) Decode

func (f *Flashes) Decode(encoded string) error

Decode the flash struct from a cookie value

func (*Flashes) Encode

func (f *Flashes) Encode() ([]byte, error)

Encode the flash struct to base64 to store in a cookie

func (*Flashes) Error

func (f *Flashes) Error(msg string)

func (*Flashes) Info

func (f *Flashes) Info(msg string)

func (*Flashes) Save

func (f *Flashes) Save(w http.ResponseWriter) error

func (*Flashes) Success

func (f *Flashes) Success(msg string)

func (*Flashes) Warning

func (f *Flashes) Warning(msg string)

type Handler

type Handler func(http.ResponseWriter, *http.Request) Response

type Layout

type Layout func(http.ResponseWriter, *http.Request, ...fido.Element) fido.Element

type PathType

type PathType map[string]Handler

func (*PathType) Delete

func (r *PathType) Delete(handler Handler) *PathType

func (*PathType) Get

func (r *PathType) Get(handler Handler) *PathType

func (*PathType) Handle

func (r *PathType) Handle(method string, handler Handler) *PathType

func (*PathType) Map

func (r *PathType) Map(route PathType) *PathType

func (*PathType) Patch

func (r *PathType) Patch(handler Handler) *PathType

func (*PathType) Post

func (r *PathType) Post(handler Handler) *PathType

func (*PathType) Put

func (r *PathType) Put(handler Handler) *PathType

type Response

type Response struct {
	// contains filtered or unexported fields
}

func Back

func Back() Response

func Content

func Content(content ...fido.Element) Response

func Error

func Error(err error) Response

func Redirect

func Redirect(url string) Response

func Respond

func Respond() Response

Error(err).WrapErr("This dog has wandered off.")

func (r Response) Wrap(msg string) Response {
	r.err = fmt.Errorf("%s: %w", msg, r.err)
	return r
}

func Success

func Success(msg string) Response

func (Response) Back

func (r Response) Back() Response

func (Response) Content

func (r Response) Content(content ...fido.Element) Response

func (Response) Error

func (r Response) Error(err error) Response

func (Response) GetContent

func (r Response) GetContent() []fido.Element

func (r Response) ErrPublic() string {
	if r.err == nil {
		return ""
	}
	parts := strings.Split(r.err.Error(), ":")
	if len(parts) < 1 {
		return ""
	}
	return strings.TrimSpace(parts[0])
}

func (r Response) ErrDetail() string {
	if r.err == nil {
		return ""
	}
	parts := strings.Split(r.err.Error(), ":")
	if len(parts) < 2 {
		return ""
	}
	// join all the parts after the first one with :
	return strings.TrimSpace(strings.Join(parts[1:], ": "))
}

func (Response) Header

func (r Response) Header(key, value string) Response

func (Response) Info

func (r Response) Info(msg string, expiry ...int) Response

func (Response) Notify

func (r Response) Notify(msg string, urgency Urgency, expiry ...int) Response

func (Response) PushUrl

func (r Response) PushUrl(url string) Response

func (Response) Redirect

func (r Response) Redirect(url string) Response

func (Response) ReplaceUrl

func (r Response) ReplaceUrl(url string) Response

func (Response) Success

func (r Response) Success(msg string, expiry ...int) Response

func (Response) Warning

func (r Response) Warning(msg string, expiry ...int) Response

type Router

type Router struct {
	Mux *http.ServeMux
	// contains filtered or unexported fields
}

func New

func New(mux *http.ServeMux, layout Layout, flashRenderer FlashRenderer) *Router

func (*Router) Handle

func (router *Router) Handle(pattern string, handler func(http.ResponseWriter, *http.Request))

func (router *Router) Route(router *Router) *Router {
	for path, route := range routes {
		router.Path(path).Map(*route)
	}
	return router
}

func (*Router) HandleFunc

func (router *Router) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

func (*Router) Path

func (router *Router) Path(path string) *PathType

func (*Router) Verbose

func (router *Router) Verbose(verbose bool)

type Urgency

type Urgency string

const (
	SuccessUrgency Urgency = "success"
	ErrorUrgency   Urgency = "error"
	InfoUrgency    Urgency = "info"
	WarningUrgency Urgency = "warning"
)