air

type Air struct {
	Config           *Config
	Logger           Logger
	Binder           Binder
	Minifier         Minifier
	Renderer         Renderer
	Coffer           Coffer
	HTTPErrorHandler HTTPErrorHandler
	// contains filtered or unexported fields
}

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

type Binder interface {
	// Bind binds the body of the req into the provided type i.
	Bind(i interface{}, req *Request) error
}

type Coffer interface {
	// Init initializes the `Coffer`. It will be called in the `Air#Serve()`.
	Init() error

	// Asset returns an `Asset` in the `Coffer` for the provided name.
	//
	// **Please use the `filepath.Abs()` to process the name before calling.**
	Asset(name string) *Asset
}

type Config struct {
	// AppName represents the name of the `Air` instance.
	//
	// The default Value is "air".
	//
	// It's called "app_name" in the config file.
	AppName string

	// DebugMode indicates whether to enable the debug mode when the HTTP server is started.
	//
	// The default value is false.
	//
	// It's called "debug_mode" in the config file.
	DebugMode bool

	// LoggerEnabled indicates whether to enable the `Logger` when the HTTP server is started.
	// It works only with the default `Logger`.
	//
	// It will be forced to the true if the `DebugMode` is true.
	//
	// The default value is false.
	//
	// It's called "logger_enabled" in the config file.
	LoggerEnabled bool

	// LogFormat represents the format of the output content of the `Logger`. It works only with
	// the default `Logger` and when the `LoggerEnabled` is true.
	//
	// The default value is:
	// `{"app_name":"{{.app_name}}","time":"{{.time_rfc3339}}","level":"{{.level}}",` +
	// `"file":"{{.short_file}}","line":"{{.line}}"}`
	//
	// It's called "log_format" in the config file.
	LogFormat string

	// Address represents the TCP address that the HTTP server to listen on.
	//
	// The default value is "localhost:2333".
	//
	// It's called "address" in the config file.
	Address string

	// ReadTimeout represents the maximum duration before timing out read of the HTTP request.
	//
	// The default value is 0.
	//
	// It's called "read_timeout" in the config file.
	//
	// **It's unit in the config file is MILLISECONDS.**
	ReadTimeout time.Duration

	// WriteTimeout represents the maximum duration before timing out write of the HTTP
	// response.
	//
	// The default value is 0.
	//
	// It's called "write_timeout" in the config file.
	//
	// **It's unit in the config file is MILLISECONDS.**
	WriteTimeout time.Duration

	// MaxHeaderBytes represents the maximum number of bytes the HTTP server will read parsing
	// the HTTP request header's keys and values, including the HTTP request line. It does not
	// limit the size of the HTTP request body.
	//
	// The default value is 1048576.
	//
	// It's called "max_header_bytes" in the config file.
	MaxHeaderBytes int

	// TLSCertFile represents the path of the TLS certificate file.
	//
	// The default value is "".
	//
	// It's called "tls_cert_file" in the config file.
	TLSCertFile string

	// TLSKeyFile represents the path of the TLS key file.
	//
	// The default value is "".
	//
	// It's called "tls_key_file" in the config file.
	TLSKeyFile string

	// TemplateRoot represents the root directory of the HTML templates. It will be parsed into
	// the `Renderer`. It works only with the default `Renderer`.
	//
	// The default value is "templates" that means a subdirectory of the runtime directory.
	//
	// It's called "template_root" in the config file.
	TemplateRoot string

	// TemplateExts represents the file name extensions of the HTML templates. It will be used
	// when parsing the HTML templates. It works only with the default `Renderer`.
	//
	// The default value is [".html"].
	//
	// It's called "template_exts" in the config file.
	TemplateExts []string

	// TemplateLeftDelim represents the left side of the HTML template delimiter. It will be
	// used when parsing the HTML templates. It works only with the default `Renderer`.
	//
	// The default value is "{{".
	//
	// It's called "template_left_delim" in the config file.
	TemplateLeftDelim string

	// TemplateRightDelim represents the right side of the HTML template delimiter. It will be
	// used when parsing the HTML templates. It works only with the default `Renderer`.
	//
	// The default value is "}}".
	//
	// It's called "template_right_delim" in the config file.
	TemplateRightDelim string

	// TemplateMinified indicates whether to minify the HTML templates before they being parsed
	// into the `Renderer`. It works only with the default `Renderer`.
	//
	// The default value is false.
	//
	// It's called "template_minified" in the config file.
	TemplateMinified bool

	// CofferEnabled indicates whether to enable the `Coffer` when the HTTP server is started.
	// It works only with the default `Coffer`.
	//
	// The default value is false.
	//
	// It's called "coffer_enabled" in the config file.
	CofferEnabled bool

	// AssetRoot represents the root directory of the asset files. It will be loaded into the
	// `Coffer`. It works only with the default `Coffer` and when the `CofferEnabled` is true.
	//
	// The default value is "assets" that means a subdirectory of the runtime directory.
	//
	// It's called "asset_root" in the config file.
	AssetRoot string

	// AssetExts represents the file name extensions of the asset files. It will be used when
	// loading the asset files. It works only with the default `Coffer` and when the
	// `CofferEnabled` is true.
	//
	// The default value is [".html", ".css", ".js", ".json", ".xml", ".svg"].
	//
	// It's called "asset_exts" in the config file.
	AssetExts []string

	// AssetMinified indicates whether to minify the asset files before they being loaded into
	// the `Coffer`. It works only with the default `Coffer` and when the `CofferEnabled` is
	// true.
	//
	// The default value is false.
	//
	// It's called "asset_minified" in the config file.
	AssetMinified bool

	// Data represents the data that parsing from the config file. You can use it to access the
	// values in the config file.
	//
	// e.g. Data["foobar"] will accesses the value in the config file called "foobar".
	Data Map
}

type Context struct {
	context.Context

	Air *Air

	Request  *Request
	Response *Response

	PristinePath string
	ParamNames   []string
	ParamValues  []string
	Handler      Handler

	// Cancel is non-nil if one of the `SetCancel()`, the `SetDeadline()` or the `SetTimeout()`
	// is called. It will be called when the HTTP server finishes the current cycle if it is
	// non-nil and has never been called.
	Cancel context.CancelFunc

	// Data is an alias for the `Response#Data`.
	Data Map
}

type Gas func(Handler) Handler

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

type HTTPError struct {
	Code    int
	Message string
}

type HTTPErrorHandler func(error, *Context)

type Handler func(*Context) error

type Logger interface {
	// Output returns the output of the `Logger`.
	Output() io.Writer

	// SetOutput sets the w to the output of the `Logger`.
	SetOutput(w io.Writer)

	// Print prints the log info with the provided type i.
	Print(i ...interface{})

	// Printf prints the log info in the format with the provided args.
	Printf(format string, args ...interface{})

	// Printj prints the log info in the JSON format with the provided m.
	Printj(m Map)

	// Debug prints the DEBUG level log info with the provided type i.
	Debug(i ...interface{})

	// Debugf prints the DEBUG level log info in the format with the provided args.
	Debugf(format string, args ...interface{})

	// Debugj prints the DEBUG level log info in the JSON format with the provided m.
	Debugj(m Map)

	// Info prints the INFO level log info with the provided type i.
	Info(i ...interface{})

	// Infof prints the INFO level log info in the format with the provided args.
	Infof(format string, args ...interface{})

	// Infoj prints the INFO level log info in the JSON format with the provided m.
	Infoj(m Map)

	// Warn prints the WARN level log info with the provided type i.
	Warn(i ...interface{})

	// Warnf prints the WARN level log info in the format with the provided args.
	Warnf(format string, args ...interface{})

	// Warnj prints the WARN level log info in the JSON format with the provided m.
	Warnj(m Map)

	// Error prints the ERROR level log info with the provided type i.
	Error(i ...interface{})

	// Errorf prints the ERROR level log info in the format with the provided args.
	Errorf(format string, args ...interface{})

	// Errorj prints the ERROR level log info in the JSON format with the provided m.
	Errorj(m Map)

	// Fatal prints the FATAL level log info with the provided type i.
	Fatal(i ...interface{})

	// Fatalf prints the FATAL level log info in the format with the provided args.
	Fatalf(format string, args ...interface{})

	// Fatalj prints the FATAL level log info in the JSON format with the provided m.
	Fatalj(m Map)
}

type Map map[string]interface{}

type Minifier interface {
	// Init initializes the `Minifier`. It will be called in the `Air#Serve()`.
	Init() error

	// Minify minifies the b by the mimeType.
	Minify(mimeType string, b []byte) ([]byte, error)
}

type Renderer interface {
	// Init initializes the `Renderer`. It will be called in the `Air#Serve()`.
	Init() error

	// SetTemplateFunc sets the func f into the `Renderer` with the name.
	SetTemplateFunc(name string, f interface{})

	// Render renders the data into the w with the templateName.
	Render(w io.Writer, templateName string, data Map) error
}

type Request struct {
	*http.Request

	URL *URL
	// contains filtered or unexported fields
}

type Response struct {
	http.ResponseWriter
	http.Hijacker
	http.CloseNotifier
	http.Flusher
	http.Pusher

	StatusCode int
	Size       int
	Written    bool
	Data       Map
	// contains filtered or unexported fields
}

type URL struct {
	*url.URL
	// contains filtered or unexported fields
}