ginext

package
v0.0.231 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BodyBuffer added in v0.0.220 

func BodyBuffer(g *gin.Context)

func CorsMiddleware 

func CorsMiddleware() gin.HandlerFunc

func Wrap 

func Wrap(w *GinWrapper, fn WHandlerFunc) gin.HandlerFunc

Types

type AppContext added in v0.0.173 

type AppContext struct {
	GinContext *gin.Context
	// contains filtered or unexported fields
}

func CreateAppContext added in v0.0.173 

func CreateAppContext(g *gin.Context, innerCtx context.Context, cancelFn context.CancelFunc) *AppContext

func (*AppContext) Cancel added in v0.0.173 

func (ac *AppContext) Cancel()

func (*AppContext) Deadline added in v0.0.173 

func (ac *AppContext) Deadline() (deadline time.Time, ok bool)

func (*AppContext) Done added in v0.0.173 

func (ac *AppContext) Done() <-chan struct{}

func (*AppContext) Err added in v0.0.173 

func (ac *AppContext) Err() error

func (*AppContext) RequestURI added in v0.0.173 

func (ac *AppContext) RequestURI() string

func (*AppContext) Set added in v0.0.213 

func (ac *AppContext) Set(key, value any)

func (*AppContext) Value added in v0.0.173 

func (ac *AppContext) Value(key any) any

type GinRouteBuilder 

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

func (*GinRouteBuilder) Handle 

func (w *GinRouteBuilder) Handle(handler WHandlerFunc)

func (*GinRouteBuilder) Use 

func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder

type GinRoutesWrapper 

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

func (*GinRoutesWrapper) Any added in v0.0.177 

func (w *GinRoutesWrapper) Any(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) COUNT 

func (w *GinRoutesWrapper) COUNT(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) DELETE 

func (w *GinRoutesWrapper) DELETE(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) GET 

func (w *GinRoutesWrapper) GET(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) Group 

func (w *GinRoutesWrapper) Group(relativePath string) *GinRoutesWrapper

func (*GinRoutesWrapper) HEAD 

func (w *GinRoutesWrapper) HEAD(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) OPTIONS 

func (w *GinRoutesWrapper) OPTIONS(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) PATCH 

func (w *GinRoutesWrapper) PATCH(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) POST 

func (w *GinRoutesWrapper) POST(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) PUT 

func (w *GinRoutesWrapper) PUT(relativePath string) *GinRouteBuilder

func (*GinRoutesWrapper) Use added in v0.0.199 

func (w *GinRoutesWrapper) Use(middleware ...gin.HandlerFunc) *GinRoutesWrapper

type GinWrapper 

type GinWrapper struct {
	SuppressGinLogs bool
	// contains filtered or unexported fields
}

func NewEngine 

func NewEngine(allowCors bool, ginDebug bool, bufferBody bool, timeout time.Duration) *GinWrapper

NewEngine creates a new (wrapped) ginEngine Parameters are: - [allowCors] Add cors handler to allow all CORS requests on the default http methods - [ginDebug] Set gin.debug to true (adds more logs) - [bufferBody] Buffers the input body stream, this way the ginext error handler can later include the whole request body - [timeout] The default handler timeout

func (*GinWrapper) DebugPrintRoutes added in v0.0.202 

func (w *GinWrapper) DebugPrintRoutes()

func (*GinWrapper) ListenAndServeHTTP added in v0.0.202 

func (w *GinWrapper) ListenAndServeHTTP(addr string, postInit func(port string)) (chan error, *http.Server)

func (*GinWrapper) NoRoute added in v0.0.177 

func (w *GinWrapper) NoRoute(handler WHandlerFunc)

func (*GinWrapper) Routes 

func (w *GinWrapper) Routes() *GinRoutesWrapper

type HTTPResponse 

type HTTPResponse interface {
	Write(g *gin.Context)
	WithHeader(k string, v string) HTTPResponse
}

func Data 

func Data(sc int, contentType string, data []byte) HTTPResponse

func Download 

func Download(mimetype string, filepath string, filename string) HTTPResponse

func DownloadData added in v0.0.221 

func DownloadData(status int, mimetype string, filename string, data []byte) HTTPResponse

func ErrWrap added in v0.0.208 

func ErrWrap(e error, errorType exerr.ErrorType, msg string) HTTPResponse

func Error added in v0.0.207 

func Error(e error) HTTPResponse

func File 

func File(mimetype string, filepath string) HTTPResponse

func JSON 

func JSON(sc int, data any) HTTPResponse

func NotImplemented 

func NotImplemented() HTTPResponse

func Redirect added in v0.0.174 

func Redirect(sc int, newURL string) HTTPResponse

func Status 

func Status(sc int) HTTPResponse

func Text 

func Text(sc int, data string) HTTPResponse

type PreContext added in v0.0.173 

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

func (*PreContext) Body added in v0.0.173 

func (pctx *PreContext) Body(body any) *PreContext

func (*PreContext) Form added in v0.0.173 

func (pctx *PreContext) Form(form any) *PreContext

func (*PreContext) Header added in v0.0.200 

func (pctx *PreContext) Header(header any) *PreContext

func (*PreContext) Query added in v0.0.173 

func (pctx *PreContext) Query(query any) *PreContext

func (PreContext) Start added in v0.0.173 

func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse)

func (*PreContext) URI added in v0.0.173 

func (pctx *PreContext) URI(uri any) *PreContext

type WHandlerFunc 

type WHandlerFunc func(PreContext) HTTPResponse

func RedirectFound 

func RedirectFound(newuri string) WHandlerFunc

func RedirectPermanent 

func RedirectPermanent(newuri string) WHandlerFunc

func RedirectTemporary 

func RedirectTemporary(newuri string) WHandlerFunc

Source Files

View all Source files

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.