Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

poteto

package module

Go to main page

Versions in this module

v1

v1.3.0

Jan 18, 2025

Changes in this version

type Poteto

+ RegisterWorkflow func(workflowType string, priority uint, workflow WorkflowFunc)

+ type PotetoWorkflows interface

+ ApplyStartUpWorkflows func() error

+ RegisterWorkflow func(workflowType string, priority uint, workflow WorkflowFunc)

+ func NewPotetoWorkflows() PotetoWorkflows

+ type UnitWorkflow struct

+ type WorkflowFunc func() error

v1.2.1

Jan 16, 2025

v1.2.0

Jan 15, 2025

v1.1.1

Jan 13, 2025

v1.1.0

Jan 9, 2025

v1.0.1

Jan 3, 2025

v1.0.0

Jan 3, 2025

v0

v0.27.0

Jan 3, 2025

Changes in this version

+ const Banner

+ var DefaultPotetoOption = PotetoOption

+ func NewHttpError(code int, messages ...any) *httpError

+ func PotetoJsonRPCAdapter[T any, S any](ctx Context, api *T) error

+ type Binder interface

+ Bind func(ctx Context, object any) error

+ func NewBinder() Binder

+ type Context interface

+ Bind func(object any) error

+ DebugParam func() (string, bool)

+ ExtractRequestHeaderParam func(key string) []string

+ Get func(key string) (any, bool)

+ GetIPFromXFFHeader func() (string, error)

+ GetPath func() string

+ GetRemoteIP func() (string, error)

+ GetRequest func() *http.Request

+ GetRequestHeaderParam func(key string) string

+ GetResponse func() *response

+ JSON func(code int, value any) error

+ JSONRPCError func(code int, message string, data string, id int) error

+ JsonDeserialize func(object any) error

+ JsonSerialize func(value any) error

+ Logger func() any

+ NoContent func() error

+ PathParam func(key string) (string, bool)

+ QueryParam func(key string) (string, bool)

+ RealIP func() (string, error)

+ RegisterTrustIPRange func(ranges *net.IPNet)

+ RequestId func() string

+ Reset func(w http.ResponseWriter, r *http.Request)

+ Set func(key string, val any)

+ SetLogger func(logger any)

+ SetParam func(paramType string, paramUnit ParamUnit)

+ SetPath func(path string)

+ SetQueryParam func(queryParams url.Values)

+ SetResponseHeader func(key, value string)

+ WriteHeader func(code int)

+ func NewContext(w http.ResponseWriter, r *http.Request) Context

+ type HandlerFunc func(ctx Context) error

+ type HttpError interface

+ Error func() string

+ SetInternalError func(err error)

+ Unwrap func() error

+ type HttpErrorHandler interface

+ HandleHttpError func(err error, ctx Context)

+ type HttpParam interface

+ AddParam func(paramType string, paramUnit ParamUnit)

+ GetParam func(paramType, key string) (string, bool)

+ JsonSerialize func() ([]byte, error)

+ func NewHttpParam() HttpParam

+ type IPHandler interface

+ CanTrust func(ip net.IP) bool

+ GetIPFromXFFHeader func(ctx Context) (string, error)

+ GetRemoteIP func(ctx Context) (string, error)

+ RealIP func(ctx Context) (string, error)

+ RegisterTrustIPRange func(ranges *net.IPNet)

+ SetIsTrustPrivateIP func(flag bool)

+ type Leaf interface

+ CONNECT func(path string, handler HandlerFunc) error

+ DELETE func(addPath string, handler HandlerFunc) error

+ GET func(addPath string, handler HandlerFunc) error

+ HEAD func(path string, handler HandlerFunc) error

+ OPTIONS func(path string, handler HandlerFunc) error

+ PATCH func(path string, handler HandlerFunc) error

+ POST func(addPath string, handler HandlerFunc) error

+ PUT func(addPath string, handler HandlerFunc) error

+ Register func(middlewares ...MiddlewareFunc) *middlewareTree

+ TRACE func(path string, handler HandlerFunc) error

+ func NewLeaf(poteto Poteto, basePath string) Leaf

+ type LeafHandler func(leaf Leaf)

+ type MiddlewareFunc func(next HandlerFunc) HandlerFunc

+ type MiddlewareTree interface

+ Insert func(pattern string, middlewares ...MiddlewareFunc) *middlewareTree

+ Register func(middlewares ...MiddlewareFunc)

+ SearchMiddlewares func(pattern string) []MiddlewareFunc

+ func NewMiddlewareTree() MiddlewareTree

+ type ParamUnit struct

+ type Poteto interface

+ CONNECT func(path string, handler HandlerFunc) error

+ Combine func(pattern string, middlewares ...MiddlewareFunc) *middlewareTree

+ DELETE func(path string, handler HandlerFunc) error

+ GET func(path string, handler HandlerFunc) error

+ HEAD func(path string, handler HandlerFunc) error

+ Leaf func(basePath string, handler LeafHandler)

+ OPTIONS func(path string, handler HandlerFunc) error

+ PATCH func(path string, handler HandlerFunc) error

+ POST func(path string, handler HandlerFunc) error

+ PUT func(path string, handler HandlerFunc) error

+ Register func(middlewares ...MiddlewareFunc)

+ Run func(addr string) error

+ RunTLS func(addr string, cert, key []byte) error

+ ServeHTTP func(w http.ResponseWriter, r *http.Request)

+ SetLogger func(logger any)

+ Stop func(ctx stdContext.Context) error

+ TRACE func(path string, handler HandlerFunc) error

+ func New() Poteto

+ func NewWithOption(option PotetoOption) Poteto

+ type PotetoOption struct

+ ListenerNetwork string

+ WithRequestId bool

+ type Response interface

+ AddHeader func(key, value string)

+ Header func() http.Header

+ SetHeader func(key, value string)

+ SetStatus func(code int)

+ Write func(b []byte) (int, error)

+ WriteHeader func(code int)

+ func NewResponse(w http.ResponseWriter) Response

+ type Route interface

+ GetHandler func() HandlerFunc

+ Insert func(path string, handler HandlerFunc)

+ Search func(path string) (*route, []ParamUnit)

+ func NewRoute() Route

+ type Router interface

+ CONNECT func(path string, handler HandlerFunc) error

+ DELETE func(path string, handler HandlerFunc) error

+ GET func(path string, handler HandlerFunc) error

+ GetRoutesByMethod func(method string) *route

+ HEAD func(path string, handler HandlerFunc) error

+ OPTIONS func(path string, handler HandlerFunc) error

+ PATCH func(path string, handler HandlerFunc) error

+ POST func(path string, handler HandlerFunc) error

+ PUT func(path string, handler HandlerFunc) error

+ TRACE func(path string, handler HandlerFunc) error

+ func NewRouter() Router