web

type Binder interface {
	// Bind takes data out of the request and decodes into a struct according
	// to the Content-Type of the request.
	Bind(ctx Context, i interface{}) (err error)
}

type ContentDisposition struct {
	Type string
	Name string
}

type Context interface {
	// Reset resets the context after request completes. It must be called along
	// with `Server#AcquireContext()` and `Server#ReleaseContext()`.
	// See `Server#ServeHTTP()`
	Reset(r *http.Request, w http.ResponseWriter)

	// Server returns the `Server` instance.
	Server() *Server

	// Logger returns the `Logger` instance.
	Logger() log.Logger

	// User returns info of current visitor.
	User() User

	// SetUser set user info of current visitor. Generally used by authentication filter.
	SetUser(user User)

	// Get retrieves data from the context.
	Get(key string) interface{}

	// Set saves data in the context.
	Set(key string, value interface{})

	// Bind binds the request body into `i`.
	// Validator must be registered using `Server#Validator` if validate arg is true.
	Bind(i interface{}, validate ...bool) error

	// Route returns the registered route path for current handler.
	Route() string

	// Handler returns the matched handler info by router.
	Handler() HandlerInfo

	// Error invokes the registered HTTP error handler. Generally used by filters.
	Error(err error)

	Requester

	Responser
}

type Entry struct {
	Address string // http://:8001,https://auxo.net:443,unix:///a/b
	TLS     *struct {
		Cert string
		Key  string
		ACME *struct {
			//Server string // default: https://acme-staging.api.letsencrypt.org/directory
			Domain   string
			Email    string
			CacheDir string
		}
	}
}

type Error errors.CodedError

type ErrorHandler struct {
	Detail  bool
	Default ErrorHandlerFunc
	// contains filtered or unexported fields
}

type ErrorHandlerFunc func(Context, error)

type Filter interface {
	Apply(HandlerFunc) HandlerFunc
}

type FilterFunc func(HandlerFunc) HandlerFunc

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

type HandlerFunc func(Context) error

type HandlerInfo interface {
	Action() HandlerFunc
	Name() string
	Authorize() string
	Option(name string) string
}

type HandlerOption func(*handlerInfo)

type Options struct {
	// Name is used as HTTP `Server` header, default is auxo/[auxo.Version]
	Name                  string
	Mode                  string // develop/release
	Entries               []Entry
	RedirectTrailingSlash bool
	MethodNotAllowed      bool
	ReadTimeout           time.Duration
	ReadHeaderTimeout     time.Duration
	WriteTimeout          time.Duration
	IdleTimeout           time.Duration
	MaxHeaderSize         size.Size
	MaxBodySize           size.Size
	Authorize             string   // default authorize
	IndexPages            []string // static index pages, default: index.html

}

type Renderer interface {
	Render(io.Writer, string, interface{}, Context) error
}

type Requester interface {
	// Request returns `*http.Request`.
	Request() *http.Request

	// SetRequest replace default `*http.Request`.
	SetRequest(r *http.Request)

	// IsTLS returns true if HTTP connection is TLS otherwise false.
	IsTLS() bool

	// Scheme returns the HTTP protocol scheme, `http` or `https`.
	Scheme() string

	// RealIP returns the client's network address based on `X-Forwarded-For`
	// or `X-Real-IP` request header.
	RealIP() string

	// IsAJAX returns true if this request is an AJAX request(XMLHttpRequest)
	IsAJAX() bool

	// Path returns path parameter by name.
	Path(name string) string

	// P returns path parameter by name, it's an alias of Path method.
	P(name string) string

	// PathNames returns path parameter names.
	PathNames() []string

	// SetPathNames sets path parameter names.
	SetPathNames(names ...string)

	// PathValues returns path parameter values.
	PathValues() []string

	// SetPathValues sets path parameter values.
	SetPathValues(values ...string)

	// Query returns the query param for the provided name.
	Query(name string) string

	// Q returns the query param for the provided name, it's an alias of Query method.
	Q(name string) string

	// QueryValues returns the query parameters as `url.Values`.
	QueryValues() url.Values

	// Form returns the form field value for the provided name.
	Form(name string) string

	// F returns the form field value for the provided name, it's an alias of Form method.
	F(name string) string

	// FormValues returns the form parameters as `url.Values`.
	FormValues() (url.Values, error)

	// File returns the multipart form file for the provided name.
	File(name string) (multipart.File, *multipart.FileHeader, error)

	// MultipartForm returns the multipart form.
	MultipartForm() (*multipart.Form, error)

	// Cookie returns the named cookie provided in the request.
	Cookie(name string) (*http.Cookie, error)

	// Header returns request's header by name.
	Header(name string) string

	// ContentType returns the 'Content-Type' header of request. Charset is omited.
	ContentType() string
}

type ResponseWriter interface {
	http.ResponseWriter
	http.Flusher
	http.Hijacker
	http.Pusher
	WriteString(s string) (n int, err error)
	Committed() bool
	Size() int
	Status() int
}

type Responser interface {
	// Response returns `ResponseWriter`.
	Response() ResponseWriter

	// Status set status code of response.
	Status(code int) Responser

	// SetCookie adds a `Set-Cookie` header in HTTP response.
	SetCookie(cookie *http.Cookie) Responser

	// SetHeader writes given key and value to the response's header.
	SetHeader(key, value string) Responser

	// SetContentType sets the 'Content-Type' header of response.
	SetContentType(ct string) Responser

	// Render renders a template with data and sends a text/html response.
	// Renderer must be registered using `Server.Renderer`.
	Render(name string, data interface{}) error

	// HTML sends an text/html response.
	HTML(html string) error

	// JSON sends a JSON response.
	JSON(i interface{}, indent ...string) error

	// JSONP sends a JSONP response. It uses `callback` to construct the JSONP payload.
	JSONP(callback string, i interface{}) error

	Result(code int32, info string, data interface{}) error

	// XML sends an XML response.
	XML(i interface{}, indent ...string) error

	// Text sends string as plain text.
	Text(s string) error

	// Data sends byte array to response.
	// You can use `Context.SetContentType` to set content type.
	Data(b []byte, cd ...ContentDisposition) error

	// Stream sends a streaming response.
	// You can use `Context.SetContentType` to set content type.
	Stream(r io.Reader, cd ...ContentDisposition) error

	// Content sends a response with the content of the file.
	Content(file string, cd ...ContentDisposition) error

	// Empty sends a response with no body.
	// You can use `Context.Status` to change status code (default is 200).
	Empty() error

	// Redirect redirects the request to a provided URL with status code.
	// You can use `Context.Status` to change status code.
	// If code wasn't set, default is 302 (http.StatusFound).
	Redirect(url string) error
}

type Router interface {
	Group(prefix string, filters ...Filter) *Group
	Use(filters ...Filter)

	Get(path string, h HandlerFunc, opts ...HandlerOption)
	Post(path string, h HandlerFunc, opts ...HandlerOption)
	Delete(path string, h HandlerFunc, opts ...HandlerOption)
	Put(path string, h HandlerFunc, opts ...HandlerOption)
	Head(path string, h HandlerFunc, opts ...HandlerOption)
	Options(path string, h HandlerFunc, opts ...HandlerOption)
	Patch(path string, h HandlerFunc, opts ...HandlerOption)
	Trace(path string, h HandlerFunc, opts ...HandlerOption)
	Connect(path string, h HandlerFunc, opts ...HandlerOption)
	Any(path string, handler HandlerFunc, opts ...HandlerOption)
	Match(methods []string, path string, h HandlerFunc, opts ...HandlerOption)
	Handle(path string, controller interface{}, filters ...Filter)

	Static(prefix string, fs http.FileSystem, fallback string, filters ...Filter)
	File(path string, fs http.FileSystem, name string, filters ...Filter)
}

type Server struct {
	ErrorHandler ErrorHandler
	Binder       Binder
	Validator    Validator
	Renderer     Renderer
	Logger       log.Logger
	// contains filtered or unexported fields
}

type Unmarshaler interface {
	// Unmarshal converts a param value to type.
	Unmarshal(param interface{}) error
}

type User = security.User

type Validator interface {
	Validate(i interface{}) error
}