1
0
mirror of https://github.com/labstack/echo.git synced 2025-09-16 09:16:29 +02:00

More godoc

Signed-off-by: Vishal Rana <vr@labstack.com>
This commit is contained in:
Vishal Rana
2016-03-14 23:33:16 -07:00
parent fd8744406f
commit e4ab053bc8
10 changed files with 70 additions and 70 deletions

View File

@@ -16,22 +16,22 @@ type (
}
)
// Add implements `Header#Add` method.
// Add implements `engine.Header#Add` method.
func (h *RequestHeader) Add(key, val string) {
// h.RequestHeader.Add(key, val)
}
// Del implements `Header#Del` method.
// Del implements `engine.Header#Del` method.
func (h *RequestHeader) Del(key string) {
h.RequestHeader.Del(key)
}
// Set implements `Header#Set` method.
// Set implements `engine.Header#Set` method.
func (h *RequestHeader) Set(key, val string) {
h.RequestHeader.Set(key, val)
}
// Get implements `Header#Get` method.
// Get implements `engine.Header#Get` method.
func (h *RequestHeader) Get(key string) string {
return string(h.Peek(key))
}
@@ -40,22 +40,22 @@ func (h *RequestHeader) reset(hdr *fasthttp.RequestHeader) {
h.RequestHeader = hdr
}
// Add implements `Header#Add` method.
// Add implements `engine.Header#Add` method.
func (h *ResponseHeader) Add(key, val string) {
// h.header.Add(key, val)
}
// Del implements `Header#Del` method.
// Del implements `engine.Header#Del` method.
func (h *ResponseHeader) Del(key string) {
h.ResponseHeader.Del(key)
}
// Get implements `Header#Get` method.
// Get implements `engine.Header#Get` method.
func (h *ResponseHeader) Get(key string) string {
return string(h.Peek(key))
}
// Set implements `Header#Set` method.
// Set implements `engine.Header#Set` method.
func (h *ResponseHeader) Set(key, val string) {
h.ResponseHeader.Set(key, val)
}

View File

@@ -23,72 +23,72 @@ type (
}
)
// TLS implements `Request#TLS` method.
// TLS implements `engine.Request#TLS` method.
func (r *Request) TLS() bool {
return r.IsTLS()
}
// Scheme implements `Request#Scheme` method.
// Scheme implements `engine.Request#Scheme` method.
func (r *Request) Scheme() string {
return string(r.RequestCtx.URI().Scheme())
}
// Host implements `Request#Host` method.
// Host implements `engine.Request#Host` method.
func (r *Request) Host() string {
return string(r.RequestCtx.Host())
}
// URL implements `Request#URL` method.
// URL implements `engine.Request#URL` method.
func (r *Request) URL() engine.URL {
return r.url
}
// Header implements `Request#Header` method.
// Header implements `engine.Request#Header` method.
func (r *Request) Header() engine.Header {
return r.header
}
// UserAgent implements `Request#UserAgent` method.
// UserAgent implements `engine.Request#UserAgent` method.
func (r *Request) UserAgent() string {
return string(r.RequestCtx.UserAgent())
}
// RemoteAddress implements `Request#RemoteAddress` method.
// RemoteAddress implements `engine.Request#RemoteAddress` method.
func (r *Request) RemoteAddress() string {
return r.RemoteAddr().String()
}
// Method implements `Request#Method` method.
// Method implements `engine.Request#Method` method.
func (r *Request) Method() string {
return string(r.RequestCtx.Method())
}
// SetMethod implements `Request#SetMethod` method.
// SetMethod implements `engine.Request#SetMethod` method.
func (r *Request) SetMethod(method string) {
r.Request.Header.SetMethod(method)
}
// URI implements `Request#URI` method.
// URI implements `engine.Request#URI` method.
func (r *Request) URI() string {
return string(r.RequestURI())
}
// Body implements `Request#Body` method.
// Body implements `engine.Request#Body` method.
func (r *Request) Body() io.ReadCloser {
return ioutil.NopCloser(bytes.NewBuffer(r.PostBody()))
}
// FormValue implements `Request#FormValue` method.
// FormValue implements `engine.Request#FormValue` method.
func (r *Request) FormValue(name string) string {
return string(r.RequestCtx.FormValue(name))
}
// FormFile implements `Request#FormFile` method.
// FormFile implements `engine.Request#FormFile` method.
func (r *Request) FormFile(name string) (*multipart.FileHeader, error) {
return r.RequestCtx.FormFile(name)
}
// MultipartForm implements `Request#MultipartForm` method.
// MultipartForm implements `engine.Request#MultipartForm` method.
func (r *Request) MultipartForm() (*multipart.Form, error) {
return r.RequestCtx.MultipartForm()
}

View File

@@ -24,12 +24,12 @@ type (
}
)
// Header implements `Response#Header` method.
// Header implements `engine.Response#Header` method.
func (r *Response) Header() engine.Header {
return r.header
}
// WriteHeader implements `Response#WriteHeader` method.
// WriteHeader implements `engine.Response#WriteHeader` method.
func (r *Response) WriteHeader(code int) {
if r.committed {
r.logger.Warn("response already committed")
@@ -40,32 +40,32 @@ func (r *Response) WriteHeader(code int) {
r.committed = true
}
// Write implements `Response#Write` method.
// Write implements `engine.Response#Write` method.
func (r *Response) Write(b []byte) (int, error) {
return r.RequestCtx.Write(b)
}
// Status implements `Response#Status` method.
// Status implements `engine.Response#Status` method.
func (r *Response) Status() int {
return r.status
}
// Size implements `Response#Size` method.
// Size implements `engine.Response#Size` method.
func (r *Response) Size() int64 {
return r.size
}
// Committed implements `Response#Committed` method.
// Committed implements `engine.Response#Committed` method.
func (r *Response) Committed() bool {
return r.committed
}
// Writer implements `Response#Writer` method.
// Writer implements `engine.Response#Writer` method.
func (r *Response) Writer() io.Writer {
return r.writer
}
// SetWriter implements `Response#SetWriter` method.
// SetWriter implements `engine.Response#SetWriter` method.
func (r *Response) SetWriter(w io.Writer) {
r.writer = w
}

View File

@@ -84,17 +84,17 @@ func NewFromConfig(c engine.Config) (s *Server) {
return
}
// SetHandler implements `Engine#SetHandler` method.
// SetHandler implements `engine.Engine#SetHandler` method.
func (s *Server) SetHandler(h engine.Handler) {
s.handler = h
}
// SetLogger implements `Engine#SetLogger` method.
// SetLogger implements `engine.Engine#SetLogger` method.
func (s *Server) SetLogger(l *log.Logger) {
s.logger = l
}
// Start implements `Engine#Start` method.
// Start implements `engine.Engine#Start` method.
func (s *Server) Start() {
handler := func(c *fasthttp.RequestCtx) {
// Request

View File

@@ -11,19 +11,19 @@ type (
}
)
// Path implements `URL#Path` method.
// Path implements `engine.URL#Path` method.
func (u *URL) Path() string {
return string(u.URI.Path())
}
// SetPath implements `URL#SetPath` method.
// SetPath implements `engine.URL#SetPath` method.
func (u *URL) SetPath(path string) {
// return string(u.URI.Path())
u.URI.SetPath(path)
}
// QueryValue implements `URL#QueryValue` method.
// QueryValue implements `engine.URL#QueryValue` method.
func (u *URL) QueryValue(name string) string {
return ""
return string(u.QueryArgs().Peek(name))
}
func (u *URL) reset(uri *fasthttp.URI) {

View File

@@ -9,22 +9,22 @@ type (
}
)
// Add implements `Header#Add` method.
// Add implements `engine.Header#Add` method.
func (h *Header) Add(key, val string) {
h.Header.Add(key, val)
}
// Del implements `Header#Del` method.
// Del implements `engine.Header#Del` method.
func (h *Header) Del(key string) {
h.Header.Del(key)
}
// Set implements `Header#Set` method.
// Set implements `engine.Header#Set` method.
func (h *Header) Set(key, val string) {
h.Header.Set(key, val)
}
// Get implements `Header#Get` method.
// Get implements `engine.Header#Get` method.
func (h *Header) Get(key string) string {
return h.Header.Get(key)
}

View File

@@ -17,12 +17,12 @@ type (
}
)
// TLS implements `Request#TLS` method.
// TLS implements `engine.Request#TLS` method.
func (r *Request) TLS() bool {
return r.Request.TLS != nil
}
// Scheme implements `Request#Scheme` method.
// Scheme implements `engine.Request#Scheme` method.
func (r *Request) Scheme() string {
if r.TLS() {
return "https"
@@ -30,17 +30,17 @@ func (r *Request) Scheme() string {
return "http"
}
// Host implements `Request#Host` method.
// Host implements `engine.Request#Host` method.
func (r *Request) Host() string {
return r.Request.Host
}
// URL implements `Request#URL` method.
// URL implements `engine.Request#URL` method.
func (r *Request) URL() engine.URL {
return r.url
}
// Header implements `Request#URL` method.
// Header implements `engine.Request#URL` method.
func (r *Request) Header() engine.Header {
return r.header
}
@@ -57,48 +57,48 @@ func (r *Request) Header() engine.Header {
// return r.request.ProtoMinor()
// }
// UserAgent implements `Request#UserAgent` method.
// UserAgent implements `engine.Request#UserAgent` method.
func (r *Request) UserAgent() string {
return r.Request.UserAgent()
}
// RemoteAddress implements `Request#RemoteAddress` method.
// RemoteAddress implements `engine.Request#RemoteAddress` method.
func (r *Request) RemoteAddress() string {
return r.RemoteAddr
}
// Method implements `Request#Method` method.
// Method implements `engine.Request#Method` method.
func (r *Request) Method() string {
return r.Request.Method
}
// SetMethod implements `Request#SetMethod` method.
// SetMethod implements `engine.Request#SetMethod` method.
func (r *Request) SetMethod(method string) {
r.Request.Method = method
}
// URI implements `Request#URI` method.
// URI implements `engine.Request#URI` method.
func (r *Request) URI() string {
return r.RequestURI
}
// Body implements `Request#Body` method.
// Body implements `engine.Request#Body` method.
func (r *Request) Body() io.ReadCloser {
return r.Request.Body
}
// FormValue implements `Request#FormValue` method.
// FormValue implements `engine.Request#FormValue` method.
func (r *Request) FormValue(name string) string {
return r.Request.FormValue(name)
}
// FormFile implements `Request#FormFile` method.
// FormFile implements `engine.Request#FormFile` method.
func (r *Request) FormFile(name string) (*multipart.FileHeader, error) {
_, fh, err := r.Request.FormFile(name)
return fh, err
}
// MultipartForm implements `Request#MultipartForm` method.
// MultipartForm implements `engine.Request#MultipartForm` method.
func (r *Request) MultipartForm() (*multipart.Form, error) {
r.Request.ParseMultipartForm(32 << 20) // 32 MB
return r.Request.MultipartForm, nil

View File

@@ -21,12 +21,12 @@ type (
}
)
// Header implements `Response#Header` method.
// Header implements `engine.Response#Header` method.
func (r *Response) Header() engine.Header {
return r.header
}
// WriteHeader implements `Response#WriteHeader` method.
// WriteHeader implements `engine.Response#WriteHeader` method.
func (r *Response) WriteHeader(code int) {
if r.committed {
r.logger.Warn("response already committed")
@@ -37,34 +37,34 @@ func (r *Response) WriteHeader(code int) {
r.committed = true
}
// Write implements `Response#Write` method.
// Write implements `engine.Response#Write` method.
func (r *Response) Write(b []byte) (n int, err error) {
n, err = r.writer.Write(b)
r.size += int64(n)
return
}
// Status implements `Response#Status` method.
// Status implements `engine.Response#Status` method.
func (r *Response) Status() int {
return r.status
}
// Size implements `Response#Size` method.
// Size implements `engine.Response#Size` method.
func (r *Response) Size() int64 {
return r.size
}
// Committed implements `Response#Committed` method.
// Committed implements `engine.Response#Committed` method.
func (r *Response) Committed() bool {
return r.committed
}
// Writer implements `Response#Writer` method.
// Writer implements `engine.Response#Writer` method.
func (r *Response) Writer() io.Writer {
return r.writer
}
// SetWriter implements `Response#SetWriter` method.
// SetWriter implements `engine.Response#SetWriter` method.
func (r *Response) SetWriter(w io.Writer) {
r.writer = w
}

View File

@@ -80,17 +80,17 @@ func NewFromConfig(c engine.Config) (s *Server) {
return
}
// SetHandler implements `Engine#SetHandler` method.
// SetHandler implements `engine.Engine#SetHandler` method.
func (s *Server) SetHandler(h engine.Handler) {
s.handler = h
}
// SetLogger implements `Engine#SetLogger` method.
// SetLogger implements `engine.Engine#SetLogger` method.
func (s *Server) SetLogger(l *log.Logger) {
s.logger = l
}
// Start implements `Engine#Start` method.
// Start implements `engine.Engine#Start` method.
func (s *Server) Start() {
certfile := s.config.TLSCertfile
keyfile := s.config.TLSKeyfile

View File

@@ -10,17 +10,17 @@ type (
}
)
// Path implements `URL#Path` method.
// Path implements `engine.URL#Path` method.
func (u *URL) Path() string {
return u.URL.Path
}
// SetPath implements `URL#SetPath` method.
// SetPath implements `engine.URL#SetPath` method.
func (u *URL) SetPath(path string) {
u.URL.Path = path
}
// QueryValue implements `URL#QueryValue` method.
// QueryValue implements `engine.URL#QueryValue` method.
func (u *URL) QueryValue(name string) string {
if u.query == nil {
u.query = u.Query()