unireq

Documentation

Index

• func CheckSuperfluousURLArgs(req *http.Request, allowedArgs []string) error
• func ClientIP(req *http.Request) net.IP
• func GetURLBoolArgOrFail(ctx *gin.Context, name string, dflt bool) (bool, bool)
• func GetURLIntArgOrFail(ctx *gin.Context, name string, dflt int) (int, bool)

Functions

func CheckSuperfluousURLArgs

func CheckSuperfluousURLArgs(req *http.Request, allowedArgs []string) error

CheckSuperfluousURLArgs allows checking for presence of supported only arguments in URL. It returns first error it encounters.

func ClientIP

func ClientIP(req *http.Request) net.IP

ClientIP tries to capture actual remote client IP address even if the client communicates with proxy servers. Please note that the "forwarded" HTTP header is not supported.

In case nothing is found, nil is returned.

func GetURLBoolArgOrFail

func GetURLBoolArgOrFail(ctx *gin.Context, name string, dflt bool) (bool, bool)

GetURLBoolArgOrFail reads a string-encoded bool argument (= '1', '0') from URL query. If not set, then `dflt` is returned (i.e. value not present is considered a non-error). The second returned value is an "OK" flag. In case of an error, the function writes a HTTP response and returns false as a second argument.

func GetURLIntArgOrFail

func GetURLIntArgOrFail(ctx *gin.Context, name string, dflt int) (int, bool)

GetURLIntArgOrFail reads a string-encoded integer argument from URL query. If not set, then `dflt` is returned (i.e. value not present is considered a non-error). The second returned value is an "OK" flag. In case of an error, the function writes a HTTP response and returns false as a second argument.