http

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MIMEJSON              = binding.MIMEJSON
	MIMEHTML              = binding.MIMEHTML
	MIMEXML               = binding.MIMEXML
	MIMEXML2              = binding.MIMEXML2
	MIMEPlain             = binding.MIMEPlain
	MIMEPOSTForm          = binding.MIMEPOSTForm
	MIMEMultipartPOSTForm = binding.MIMEMultipartPOSTForm
	MIMEYAML              = binding.MIMEYAML
	BodyBytesKey          = "_gin-gonic/gin/bodybyteskey"
)

Variables

This section is empty.

Functions

func Dir 

func Dir(root string, listDirectory bool) http.FileSystem

Types

type Context 

type Context struct {
	Request *http.Request
	Writer  ResponseWriter
	Params  Params

	// Keys is a key/value pair exclusively for the context of each request.
	Keys map[string]interface{}
	// Accepted defines a list of manually accepted formats for content negotiation.
	Accepted []string
	// contains filtered or unexported fields
}

func (*Context) Abort 

func (c *Context) Abort()

func (*Context) AbortWithStatus 

func (c *Context) AbortWithStatus(code int)

func (*Context) Cookie 

func (c *Context) Cookie(name string) (string, error)

func (*Context) Copy 

func (c *Context) Copy() *Context

Copy returns a copy of the current context that can be safely used outside the request's scope. This has to be used when the context has to be passed to a goroutine.

func (*Context) File 

func (c *Context) File(filepath string)

func (*Context) FormFile 

func (c *Context) FormFile(name string) (multipart.File, *multipart.FileHeader, error)

FormFile returns the first file for the provided form key.

func (*Context) Get 

func (c *Context) Get(key string) (value interface{}, exists bool)

Get returns the value for the given key, ie: (value, true). If the value does not exists it returns (nil, false)

func (*Context) GetBool 

func (c *Context) GetBool(key string) (b bool)

GetBool returns the value associated with the key as a boolean.

func (*Context) GetDuration 

func (c *Context) GetDuration(key string) (d time.Duration)

GetDuration returns the value associated with the key as a duration.

func (*Context) GetFloat64 

func (c *Context) GetFloat64(key string) (f64 float64)

GetFloat64 returns the value associated with the key as a float64.

func (*Context) GetHeader 

func (c *Context) GetHeader(key string) string

GetHeader returns value from request headers.

func (*Context) GetInt 

func (c *Context) GetInt(key string) (i int)

GetInt returns the value associated with the key as an integer.

func (*Context) GetInt64 

func (c *Context) GetInt64(key string) (i64 int64)

GetInt64 returns the value associated with the key as an integer.

func (*Context) GetPostForm 

func (c *Context) GetPostForm(key string) (string, bool)

func (*Context) GetPostFormArray 

func (c *Context) GetPostFormArray(key string) ([]string, bool)

func (*Context) GetQuery 

func (c *Context) GetQuery(key string) (string, bool)

func (*Context) GetQueryArray 

func (c *Context) GetQueryArray(key string) ([]string, bool)

func (*Context) GetString 

func (c *Context) GetString(key string) (s string)

GetString returns the value associated with the key as a string.

func (*Context) GetStringMap 

func (c *Context) GetStringMap(key string) (sm map[string]interface{})

GetStringMap returns the value associated with the key as a map of interfaces.

func (*Context) GetStringMapString 

func (c *Context) GetStringMapString(key string) (sms map[string]string)

GetStringMapString returns the value associated with the key as a map of strings.

func (*Context) GetStringMapStringSlice 

func (c *Context) GetStringMapStringSlice(key string) (smss map[string][]string)

GetStringMapStringSlice returns the value associated with the key as a map to a slice of strings.

func (*Context) GetStringSlice 

func (c *Context) GetStringSlice(key string) (ss []string)

GetStringSlice returns the value associated with the key as a slice of strings.

func (*Context) GetTime 

func (c *Context) GetTime(key string) (t time.Time)

GetTime returns the value associated with the key as time.

func (*Context) GetUInt32 

func (c *Context) GetUInt32(key string) (i uint32)

GetInt64 returns the value associated with the key as an integer.

func (*Context) HTML 

func (c *Context) HTML(code int, name string, obj interface{})

func (*Context) Header 

func (c *Context) Header(key, value string)

func (*Context) IsAborted 

func (c *Context) IsAborted() bool

IsAborted returns true if the current context was aborted.

func (*Context) JSON 

func (c *Context) JSON(code int, obj interface{})

func (*Context) MustGet 

func (c *Context) MustGet(key string) interface{}

MustGet returns the value for the given key if it exists, otherwise it panics.

func (*Context) Next 

func (c *Context) Next()

func (*Context) Param 

func (c *Context) Param(key string) string

func (*Context) PostForm 

func (c *Context) PostForm(key string) string

func (*Context) Query 

func (c *Context) Query(key string) string

func (*Context) Redirect 

func (c *Context) Redirect(code int, location string)

Redirect returns a HTTP redirect to the specific location.

func (*Context) Render 

func (c *Context) Render(code int, r render.Render)

func (*Context) SaveUploadedFile 

func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

SaveUploadedFile uploads the form file to specific dst.

func (*Context) Set 

func (c *Context) Set(key string, value interface{})

Set is used to store a new key/value pair exclusively for this context. It also lazy initializes c.Keys if it was not used previously.

func (*Context) SetCookie 

func (c *Context) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool)

func (*Context) ShouldBindBodyWith 

func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error)

ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request body into the context, and reuse when it is called again.

NOTE: This method reads the body before binding. So you should use ShouldBindWith for better performance if you need to call only once.

func (*Context) ShouldBindJSON 

func (c *Context) ShouldBindJSON(obj interface{}) error

func (*Context) ShouldBindWith 

func (c *Context) ShouldBindWith(obj interface{}, b binding.Binding) error

func (*Context) Status 

func (c *Context) Status(code int)

func (*Context) String 

func (c *Context) String(code int, format string, values ...interface{})

String writes the given string into the response body.

type H 

type H map[string]interface{}

func (H) MarshalXML 

func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

type HandlerFunc 

type HandlerFunc func(*Context)

type HandlersChain 

type HandlersChain []HandlerFunc

type Http 

type Http struct {
	cbase.ModuleBase
	RouterGroup

	MaxMultipartMemory int64 //上传文件最大尺寸

	FuncMap    template.FuncMap
	HTMLRender render.HTMLRender
	// contains filtered or unexported fields
}

func (*Http) Destroy 

func (this *Http) Destroy() (err error)

func (*Http) Init 

func (this *Http) Init(service core.IService, module core.IModule, options core.IModuleOptions) (err error)

func (*Http) LoadHTMLFiles 

func (this *Http) LoadHTMLFiles(files ...string)

func (*Http) LoadHTMLGlob 

func (this *Http) LoadHTMLGlob(pattern string)

func (*Http) NewOptions 

func (this *Http) NewOptions() (options core.IModuleOptions)

func (*Http) NoMethod 

func (this *Http) NoMethod(handlers ...HandlerFunc)

NoMethod sets the handlers called when... TODO.

func (*Http) NoRoute 

func (this *Http) NoRoute(handlers ...HandlerFunc)

NoRoute adds handlers for NoRoute. It return a 404 code by default.

func (*Http) ServeHTTP 

func (this *Http) ServeHTTP(w http.ResponseWriter, req *http.Request)

func (*Http) SetHTMLTemplate 

func (this *Http) SetHTMLTemplate(templ *template.Template)

func (*Http) Start 

func (this *Http) Start() (err error)

func (*Http) Use 

func (this *Http) Use(middleware ...HandlerFunc) IRoutes

type IHttp 

type IHttp interface {
	core.IModule
	IRoutes

	Group(relativePath string, handlers ...HandlerFunc) *RouterGroup
	// contains filtered or unexported methods
}

type IOptions 

type IOptions interface {
	GetListenPort() int
	GettCertPath() string
	GetKeyPath() string
	GetCors() bool
}

type IRoutes 

type IRoutes interface {
	Use(...HandlerFunc) IRoutes
	Handle(string, string, ...HandlerFunc) IRoutes
	Any(string, ...HandlerFunc) IRoutes
	GET(string, ...HandlerFunc) IRoutes
	POST(string, ...HandlerFunc) IRoutes
	DELETE(string, ...HandlerFunc) IRoutes
	PATCH(string, ...HandlerFunc) IRoutes
	PUT(string, ...HandlerFunc) IRoutes
	OPTIONS(string, ...HandlerFunc) IRoutes
	HEAD(string, ...HandlerFunc) IRoutes
}

type Options 

type Options struct {
	ListenPort int    `json:"-"`
	CertPath   string `json:"-"`
	KeyPath    string `json:"-"`
	Cors       bool   `json:"-"` //是否跨域
}

func (*Options) GetCors 

func (this *Options) GetCors() bool

func (*Options) GetKeyPath 

func (this *Options) GetKeyPath() string

func (*Options) GetListenPort 

func (this *Options) GetListenPort() int

func (*Options) GettCertPath 

func (this *Options) GettCertPath() string

func (*Options) LoadConfig 

func (this *Options) LoadConfig(settings map[string]interface{}) (err error)

type OutJson 

type OutJson struct {
	ErrorCode core.ErrorCode `json:"code"`
	Message   string         `json:"message"`
	Data      interface{}    `json:"data"`
}

type Param 

type Param struct {
	Key   string
	Value string
}

type Params 

type Params []Param

func (Params) ByName 

func (ps Params) ByName(name string) (va string)

func (Params) Get 

func (ps Params) Get(name string) (string, bool)

type ResponseWriter 

type ResponseWriter interface {
	http.ResponseWriter
	http.Hijacker
	http.Flusher
	http.CloseNotifier

	// Returns the HTTP response status code of the current request.
	Status() int

	// Returns the number of bytes already written into the response http body.
	// See Written()
	Size() int

	// Writes the string into the response body.
	WriteString(string) (int, error)

	// Returns true if the response body was already written.
	Written() bool

	// Forces to write the http header (status code + headers).
	WriteHeaderNow()

	// get the http.Pusher for server push
	Pusher() http.Pusher
}

ResponseWriter ...

type RouterGroup 

type RouterGroup struct {
	Handlers HandlersChain
	// contains filtered or unexported fields
}

func (*RouterGroup) Any 

func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) DELETE 

func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) GET 

func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) Group 

func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

func (*RouterGroup) HEAD 

func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) Handle 

func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) OPTIONS 

func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) PATCH 

func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) POST 

func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) PUT 

func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoutes

func (*RouterGroup) Static 

func (group *RouterGroup) Static(relativePath, root string) IRoutes

func (*RouterGroup) StaticFS 

func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes

func (*RouterGroup) StaticFile 

func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes

func (*RouterGroup) Use 

func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoutes

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.