trama

README

Trama

Trama is a simple web server for Golang forked from Handy (github.com/trajber/handy). Like Handy, it has the concept of interceptors that can be freely plugged in the pipeline of a request handling, allowing making libraries of small reusable pieces of funcionality. Also like Handy, it uses the handler to carry state across the entire request, what enables injecting arbitrary type-safe contextual information to the pipeline.

Documentation

Index

• Variables
• func New(log func(error)) *trama
• type AJAXHandler
• type AJAXInterceptor
• type AJAXInterceptorChain
  • func NewAJAXInterceptorChain(is ...AJAXInterceptor) AJAXInterceptorChain
  • func (c AJAXInterceptorChain) Chain(i AJAXInterceptor) AJAXInterceptorChain
• type BufferedResponseWriter
  • func NewBufferedResponseWriter(w http.ResponseWriter) *BufferedResponseWriter
  • func (rw *BufferedResponseWriter) Flush()
  • func (rw *BufferedResponseWriter) Header() http.Header
  • func (rw *BufferedResponseWriter) Status() int
  • func (rw *BufferedResponseWriter) Write(buf []byte) (int, error)
  • func (rw *BufferedResponseWriter) WriteHeader(code int)
• type DefaultAJAXHandler
  • func (s *DefaultAJAXHandler) Delete(w http.ResponseWriter, r *http.Request)
  • func (s *DefaultAJAXHandler) Get(w http.ResponseWriter, r *http.Request)
  • func (s *DefaultAJAXHandler) Head(w http.ResponseWriter, r *http.Request)
  • func (s *DefaultAJAXHandler) Patch(w http.ResponseWriter, r *http.Request)
  • func (s *DefaultAJAXHandler) Post(w http.ResponseWriter, r *http.Request)
  • func (s *DefaultAJAXHandler) Put(w http.ResponseWriter, r *http.Request)
• type DefaultWebHandler
  • func (d *DefaultWebHandler) Get(Response, *http.Request)
  • func (d *DefaultWebHandler) Post(Response, *http.Request)
  • func (d *DefaultWebHandler) Templates() TemplateGroupSet
• type NopAJAXInterceptor
  • func (n *NopAJAXInterceptor) After(w http.ResponseWriter, r *http.Request)
  • func (n *NopAJAXInterceptor) Before(w http.ResponseWriter, r *http.Request)
• type NopAJAXInterceptorChain
  • func (n *NopAJAXInterceptorChain) Interceptors() AJAXInterceptorChain
• type NopWebInterceptor
  • func (n *NopWebInterceptor) After(Response, *http.Request)
  • func (n *NopWebInterceptor) Before(Response, *http.Request)
• type NopWebInterceptorChain
  • func (n *NopWebInterceptorChain) Interceptors() WebInterceptorChain
• type Response
• type TemplateGroup
• type TemplateGroupSet
  • func NewTemplateGroupSet(f template.FuncMap) TemplateGroupSet
  • func (t *TemplateGroupSet) Insert(g TemplateGroup) error
• type WebHandler
• type WebInterceptor
• type WebInterceptorChain
  • func NewWebInterceptorChain(is ...WebInterceptor) WebInterceptorChain
  • func (c WebInterceptorChain) Chain(i WebInterceptor) WebInterceptorChain

Variables

var (
	ErrRouteAlreadyExists = errors.New("Route already exists")
	ErrRouteNotFound      = errors.New("Route not found")
	ErrWildcardConflict   = errors.New("Wildcard node cannot have siblings")
)

Functions

func New

func New(log func(error)) *trama

Types

type AJAXHandler

type AJAXHandler interface {
	Get(http.ResponseWriter, *http.Request)
	Post(http.ResponseWriter, *http.Request)
	Put(http.ResponseWriter, *http.Request)
	Delete(http.ResponseWriter, *http.Request)
	Patch(http.ResponseWriter, *http.Request)
	Head(http.ResponseWriter, *http.Request)
	Interceptors() AJAXInterceptorChain
}

type AJAXInterceptor

type AJAXInterceptor interface {
	Before(w http.ResponseWriter, r *http.Request)
	After(w http.ResponseWriter, r *http.Request)
}

type AJAXInterceptorChain

type AJAXInterceptorChain []AJAXInterceptor

func NewAJAXInterceptorChain

func NewAJAXInterceptorChain(is ...AJAXInterceptor) AJAXInterceptorChain

func (AJAXInterceptorChain) Chain

func (c AJAXInterceptorChain) Chain(i AJAXInterceptor) AJAXInterceptorChain

type BufferedResponseWriter

type BufferedResponseWriter struct {
	Body *bytes.Buffer
	// contains filtered or unexported fields
}

func NewBufferedResponseWriter

func NewBufferedResponseWriter(w http.ResponseWriter) *BufferedResponseWriter

func (*BufferedResponseWriter) Flush

func (rw *BufferedResponseWriter) Flush()

func (*BufferedResponseWriter) Header

func (rw *BufferedResponseWriter) Header() http.Header

Header returns the response headers.

func (*BufferedResponseWriter) Status

func (rw *BufferedResponseWriter) Status() int

func (*BufferedResponseWriter) Write

func (rw *BufferedResponseWriter) Write(buf []byte) (int, error)

Write always succeeds and writes to rw.Body, if not nil.

func (*BufferedResponseWriter) WriteHeader

func (rw *BufferedResponseWriter) WriteHeader(code int)

type DefaultAJAXHandler

type DefaultAJAXHandler struct {
	NopAJAXInterceptorChain
}

func (*DefaultAJAXHandler) Delete

func (s *DefaultAJAXHandler) Delete(w http.ResponseWriter, r *http.Request)

func (*DefaultAJAXHandler) Get

func (s *DefaultAJAXHandler) Get(w http.ResponseWriter, r *http.Request)

func (*DefaultAJAXHandler) Head

func (s *DefaultAJAXHandler) Head(w http.ResponseWriter, r *http.Request)

func (*DefaultAJAXHandler) Patch

func (s *DefaultAJAXHandler) Patch(w http.ResponseWriter, r *http.Request)

func (*DefaultAJAXHandler) Post

func (s *DefaultAJAXHandler) Post(w http.ResponseWriter, r *http.Request)

func (*DefaultAJAXHandler) Put

func (s *DefaultAJAXHandler) Put(w http.ResponseWriter, r *http.Request)

type DefaultWebHandler

type DefaultWebHandler struct {
	NopWebInterceptorChain
}

func (*DefaultWebHandler) Get

func (d *DefaultWebHandler) Get(Response, *http.Request)

func (*DefaultWebHandler) Post

func (d *DefaultWebHandler) Post(Response, *http.Request)

func (*DefaultWebHandler) Templates

func (d *DefaultWebHandler) Templates() TemplateGroupSet

type NopAJAXInterceptor

type NopAJAXInterceptor struct{}

func (*NopAJAXInterceptor) After

func (n *NopAJAXInterceptor) After(w http.ResponseWriter, r *http.Request)

func (*NopAJAXInterceptor) Before

func (n *NopAJAXInterceptor) Before(w http.ResponseWriter, r *http.Request)

type NopAJAXInterceptorChain

type NopAJAXInterceptorChain struct{}

func (*NopAJAXInterceptorChain) Interceptors

func (n *NopAJAXInterceptorChain) Interceptors() AJAXInterceptorChain

type NopWebInterceptor

type NopWebInterceptor struct{}

func (*NopWebInterceptor) After

func (n *NopWebInterceptor) After(Response, *http.Request)

func (*NopWebInterceptor) Before

func (n *NopWebInterceptor) Before(Response, *http.Request)

type NopWebInterceptorChain

type NopWebInterceptorChain struct{}

func (*NopWebInterceptorChain) Interceptors

func (n *NopWebInterceptorChain) Interceptors() WebInterceptorChain

type Response

type Response interface {
	SetTemplateGroup(name string)
	SetCookie(cookie *http.Cookie)
	Redirect(url string, statusCode int)
	ExecuteTemplate(name string, data interface{})
	TemplateName() string
}

type TemplateGroup

type TemplateGroup struct {
	Name  string
	Files []string
	// contains filtered or unexported fields
}

type TemplateGroupSet

type TemplateGroupSet struct {
	FuncMap template.FuncMap
	// contains filtered or unexported fields
}

func NewTemplateGroupSet

func NewTemplateGroupSet(f template.FuncMap) TemplateGroupSet

func (*TemplateGroupSet) Insert

func (t *TemplateGroupSet) Insert(g TemplateGroup) error

type WebHandler

type WebHandler interface {
	Get(Response, *http.Request)
	Post(Response, *http.Request)
	Interceptors() WebInterceptorChain
	Templates() TemplateGroupSet
}

type WebInterceptor

type WebInterceptor interface {
	Before(Response, *http.Request)
	After(Response, *http.Request)
}

type WebInterceptorChain

type WebInterceptorChain []WebInterceptor

func NewWebInterceptorChain

func NewWebInterceptorChain(is ...WebInterceptor) WebInterceptorChain

func (WebInterceptorChain) Chain

func (c WebInterceptorChain) Chain(i WebInterceptor) WebInterceptorChain