http

Documentation

Index

• func Background() http.Context
• func GinResponseMiddleware() httpcontract.Middleware
• func NewGinContext(ctx *gin.Context) http.Context
• func NewGinRequest(ctx *GinContext) httpcontract.Request
• func NewGinSuccess(instance *gin.Context) httpcontract.ResponseSuccess
• type BodyWriter
  • func (w *BodyWriter) Body() *bytes.Buffer
  • func (w *BodyWriter) Write(b []byte) (int, error)
  • func (w *BodyWriter) WriteString(s string) (int, error)
• type GinContext
  • func (c *GinContext) Context() context.Context
  • func (c *GinContext) Deadline() (deadline time.Time, ok bool)
  • func (c *GinContext) Done() <-chan struct{}
  • func (c *GinContext) Err() error
  • func (c *GinContext) Instance() *gin.Context
  • func (c *GinContext) Request() http.Request
  • func (c *GinContext) Response() http.Response
  • func (c *GinContext) Value(key any) any
  • func (c *GinContext) WithValue(key string, value any)
• type GinRequest
  • func (r *GinRequest) AbortWithStatus(code int)
  • func (r *GinRequest) AbortWithStatusJson(code int, jsonObj any)
  • func (r *GinRequest) Bind(obj any) error
  • func (r *GinRequest) File(name string) (contractsfilesystem.File, error)
  • func (r *GinRequest) Form(key, defaultValue string) string
  • func (r *GinRequest) FullUrl() string
  • func (r *GinRequest) Header(key, defaultValue string) string
  • func (r *GinRequest) Headers() http.Header
  • func (r *GinRequest) Input(key string) string
  • func (r *GinRequest) Ip() string
  • func (r *GinRequest) Method() string
  • func (r *GinRequest) Next()
  • func (r *GinRequest) Origin() *http.Request
  • func (r *GinRequest) Path() string
  • func (r *GinRequest) Query(key, defaultValue string) string
  • func (r *GinRequest) QueryArray(key string) []string
  • func (r *GinRequest) QueryMap(key string) map[string]string
  • func (r *GinRequest) Url() string
  • func (r *GinRequest) Validate(rules map[string]string, options ...validatecontract.Option) (validatecontract.Validator, error)
  • func (r *GinRequest) ValidateRequest(request httpcontract.FormRequest) (validatecontract.Errors, error)
• type GinResponse
  • func NewGinResponse(instance *gin.Context, origin httpcontract.ResponseOrigin) *GinResponse
  • func (r *GinResponse) Download(filepath, filename string)
  • func (r *GinResponse) File(filepath string)
  • func (r *GinResponse) Header(key, value string) httpcontract.Response
  • func (r *GinResponse) Json(code int, obj any)
  • func (r *GinResponse) Origin() httpcontract.ResponseOrigin
  • func (r *GinResponse) String(code int, format string, values ...any)
  • func (r *GinResponse) Success() httpcontract.ResponseSuccess
  • func (c *GinResponse) Writer() http.ResponseWriter
• type GinSuccess
  • func (r *GinSuccess) Json(obj any)
  • func (r *GinSuccess) String(format string, values ...any)
• type ServiceProvider
  • func (database *ServiceProvider) Boot()
  • func (database *ServiceProvider) Register()

Functions

func Background

func Background() http.Context

func GinResponseMiddleware

func GinResponseMiddleware() httpcontract.Middleware

func NewGinContext

func NewGinContext(ctx *gin.Context) http.Context

func NewGinRequest

func NewGinRequest(ctx *GinContext) httpcontract.Request

func NewGinSuccess

func NewGinSuccess(instance *gin.Context) httpcontract.ResponseSuccess

Types

type BodyWriter

type BodyWriter struct {
	gin.ResponseWriter
	// contains filtered or unexported fields
}

func (*BodyWriter) Body

func (w *BodyWriter) Body() *bytes.Buffer

func (*BodyWriter) Write

func (w *BodyWriter) Write(b []byte) (int, error)

func (*BodyWriter) WriteString

func (w *BodyWriter) WriteString(s string) (int, error)

type GinContext

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

func (*GinContext) Context

func (c *GinContext) Context() context.Context

func (*GinContext) Deadline

func (c *GinContext) Deadline() (deadline time.Time, ok bool)

func (*GinContext) Done

func (c *GinContext) Done() <-chan struct{}

func (*GinContext) Err

func (c *GinContext) Err() error

func (*GinContext) Instance

func (c *GinContext) Instance() *gin.Context

func (*GinContext) Request

func (c *GinContext) Request() http.Request

func (*GinContext) Response

func (c *GinContext) Response() http.Response

func (*GinContext) Value

func (c *GinContext) Value(key any) any

func (*GinContext) WithValue

func (c *GinContext) WithValue(key string, value any)

type GinRequest

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

func (*GinRequest) AbortWithStatus

func (r *GinRequest) AbortWithStatus(code int)

func (*GinRequest) AbortWithStatusJson

func (r *GinRequest) AbortWithStatusJson(code int, jsonObj any)

func (*GinRequest) Bind

func (r *GinRequest) Bind(obj any) error

func (*GinRequest) File

func (r *GinRequest) File(name string) (contractsfilesystem.File, error)

func (*GinRequest) Form

func (r *GinRequest) Form(key, defaultValue string) string

func (*GinRequest) FullUrl

func (r *GinRequest) FullUrl() string

func (*GinRequest) Header

func (r *GinRequest) Header(key, defaultValue string) string

func (*GinRequest) Headers

func (r *GinRequest) Headers() http.Header

func (*GinRequest) Input

func (r *GinRequest) Input(key string) string

func (*GinRequest) Ip

func (r *GinRequest) Ip() string

func (*GinRequest) Method

func (r *GinRequest) Method() string

func (*GinRequest) Next

func (r *GinRequest) Next()

func (*GinRequest) Origin

func (r *GinRequest) Origin() *http.Request

func (*GinRequest) Path

func (r *GinRequest) Path() string

func (*GinRequest) Query

func (r *GinRequest) Query(key, defaultValue string) string

func (*GinRequest) QueryArray

func (r *GinRequest) QueryArray(key string) []string

func (*GinRequest) QueryMap

func (r *GinRequest) QueryMap(key string) map[string]string

func (*GinRequest) Url

func (r *GinRequest) Url() string

func (*GinRequest) Validate

func (r *GinRequest) Validate(rules map[string]string, options ...validatecontract.Option) (validatecontract.Validator, error)

func (*GinRequest) ValidateRequest

func (r *GinRequest) ValidateRequest(request httpcontract.FormRequest) (validatecontract.Errors, error)

type GinResponse

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

func NewGinResponse

func NewGinResponse(instance *gin.Context, origin httpcontract.ResponseOrigin) *GinResponse

func (*GinResponse) Download

func (r *GinResponse) Download(filepath, filename string)

func (*GinResponse) File

func (r *GinResponse) File(filepath string)

func (*GinResponse) Header

func (r *GinResponse) Header(key, value string) httpcontract.Response

func (*GinResponse) Json

func (r *GinResponse) Json(code int, obj any)

func (*GinResponse) Origin

func (r *GinResponse) Origin() httpcontract.ResponseOrigin

func (*GinResponse) String

func (r *GinResponse) String(code int, format string, values ...any)

func (*GinResponse) Success

func (r *GinResponse) Success() httpcontract.ResponseSuccess

func (*GinResponse) Writer

func (c *GinResponse) Writer() http.ResponseWriter

type GinSuccess

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

func (*GinSuccess) Json

func (r *GinSuccess) Json(obj any)

func (*GinSuccess) String

func (r *GinSuccess) String(format string, values ...any)

type ServiceProvider

type ServiceProvider struct {
}

func (*ServiceProvider) Boot

func (database *ServiceProvider) Boot()

func (*ServiceProvider) Register

func (database *ServiceProvider) Register()