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

gz

package module

Go to main page

Versions in this module

v7

v7.13.0

Jun 22, 2023

v7.12.0

Jun 20, 2023

Changes in this version

+ func ValidateURL(raw string) error

v7.11.0

Jun 8, 2023

v7.10.0

Jun 8, 2023

v7.9.0

Jun 6, 2023

v7.8.0

Jun 2, 2023

v7.7.0

May 25, 2023

v7.6.0

May 17, 2023

v7.5.0

May 15, 2023

v7.4.0

May 11, 2023

v7.3.0

Apr 26, 2023

v7.2.0

Mar 29, 2023

Changes in this version

+ func Close(c io.Closer)

+ func CopyDir(dst, src string) error

+ func CopyFile(dst string, src string) error

+ func IsDirEmpty(path string) (bool, error)

+ func RemoveIfFound(path string) error

+ func Zip(dst, src string) (*os.File, error)

v7.1.0

Mar 1, 2023

v7.0.1

Jan 6, 2023

v7.0.0

Dec 21, 2022

Changes in this version

+ const ErrorAuthJWTInvalid

+ const ErrorAuthNoUser

+ const ErrorCastingID

+ const ErrorCollectionNotInRequest

+ const ErrorCreatingDir

+ const ErrorCreatingFile

+ const ErrorCreatingRepo

+ const ErrorDbDelete

+ const ErrorDbSave

+ const ErrorFileNotFound

+ const ErrorFileTree

+ const ErrorForm

+ const ErrorFormDuplicateFile

+ const ErrorFormDuplicateModelName

+ const ErrorFormDuplicateWorldName

+ const ErrorFormInvalidValue

+ const ErrorFormMissingFiles

+ const ErrorIDNotFound

+ const ErrorIDNotInRequest

+ const ErrorIDWrongFormat

+ const ErrorInvalidPaginationRequest

+ const ErrorInvalidSimulationStatus

+ const ErrorK8Create

+ const ErrorK8Delete

+ const ErrorLaunchGazebo

+ const ErrorLaunchingCloudInstance

+ const ErrorLaunchingCloudInstanceNotEnoughResources

+ const ErrorMarshalJSON

+ const ErrorMarshalProto

+ const ErrorMissingField

+ const ErrorModelNotInRequest

+ const ErrorNameNotFound

+ const ErrorNameWrongFormat

+ const ErrorNoDatabase

+ const ErrorNonExistentResource

+ const ErrorOwnerNotInRequest

+ const ErrorPaginationPageNotFound

+ const ErrorPayloadEmpty

+ const ErrorQueueEmpty

+ const ErrorQueueIndexOutOfBounds

+ const ErrorQueueInternalChannelClosed

+ const ErrorQueueMoveIndexBackPosition

+ const ErrorQueueMoveIndexFrontPosition

+ const ErrorQueueSwapIndexesMatch

+ const ErrorQueueTooManyListeners

+ const ErrorRemovingDir

+ const ErrorRepo

+ const ErrorResourceExists

+ const ErrorScheduler

+ const ErrorShutdownGazebo

+ const ErrorSimGroupNotFound

+ const ErrorStoppingCloudInstance

+ const ErrorUnauthorized

+ const ErrorUnexpected

+ const ErrorUnexpectedID

+ const ErrorUnknownSuffix

+ const ErrorUnmarshalJSON

+ const ErrorUnzipping

+ const ErrorUserNotInRequest

+ const ErrorUserUnknown

+ const ErrorVersionNotFound

+ const ErrorWorldNotInRequest

+ const ErrorZipNotAvailable

+ const VerbosityCritical

+ const VerbosityDebug

+ const VerbosityError

+ const VerbosityInfo

+ const VerbosityWarning

+ const WaitForNextElementChanCapacity

+ var AuthHeadersOptional = []Header

+ var AuthHeadersRequired = []Header

+ func Bool(v bool) *bool

+ func CreateJWTOptionalMiddleware(s *Server) negroni.HandlerFunc

+ func CreateJWTRequiredMiddleware(s *Server) negroni.HandlerFunc

+ func Float64(v float64) *float64

+ func GetUserIdentity(r *http.Request) (identity string, ok bool)

+ func InitDbWithCfg(cfg *DatabaseConfig) (*gorm.DB, error)

+ func Int(v int) *int

+ func Int64(v int64) *int64

+ func IsBotHandler(botHandler http.Handler, userHandler http.Handler) http.Handler

+ func IsError(err error, target error) bool

+ func IsSQLTxError(err error) bool

+ func Max(x, y int64) int64

+ func Min(x, y int64) int64

+ func NewContextWithLogger(ctx context.Context, logger Logger) context.Context

+ func NewPaginationRequest(r *http.Request) (*PaginationRequest, *ErrMsg)

+ func NewRouter() *mux.Router

+ func ParseHTMLTemplate(templateFilename string, data interface{}) (string, error)

+ func ParseTemplate(templateFilename string, data interface{}) (string, error)

+ func RandomString(strlen int) string

+ func ReadEnvVar(name string) (string, error)

+ func ReadLogVerbosityEnvVar() int

+ func ReadRollbarLogVerbosityEnvVar() int

+ func ReadStdLogEnvVar() bool

+ func SameElements(a0, b0 []string) bool

+ func SendEmail(sender, recipient, subject, body string) error

+ func StrToSlice(tagsStr string) []string

+ func String(v string) *string

+ func StringSlice(src []string) []*string

+ func Trace(skip int64) string

+ func Unzip(buff bytes.Buffer, size int64, dest string, verbose bool) error

+ func UnzipFile(zipfile string, dest string, verbose bool) error

+ func UnzipImpl(reader *zip.Reader, dest string, verbose bool) error

+ func ValidateAccessToken(token string, tx *gorm.DB) (*AccessToken, *ErrMsg)

+ func WithStack(base error) error

+ func WritePaginationHeaders(page PaginationResult, w http.ResponseWriter, r *http.Request) error

+ type AccessToken struct

+ CreatedAt time.Time

+ Expires *time.Time

+ ID uint

+ Key string

+ LastUsed *time.Time

+ Name string

+ Prefix string

+ UserID uint

+ type AccessTokenCreateRequest struct

+ Name string

+ func (createReq *AccessTokenCreateRequest) Create(tx *gorm.DB) (*AccessTokenCreateResponse, *AccessToken, *ErrMsg)

+ type AccessTokenCreateResponse struct

+ Key string

+ Name string

+ Prefix string

+ type AccessTokens []AccessToken

+ type DatabaseConfig struct

+ Address string

+ EnableLog bool

+ MaxOpenConns int

+ Name string

+ Password string

+ UserName string

+ func NewDatabaseConfigFromEnvVars() (DatabaseConfig, error)

+ type Detail struct

+ Description string

+ Required bool

+ Type string

+ type ErrMsg struct

+ BaseError error

+ ErrCode int

+ ErrID string

+ Extra []string

+ Msg string

+ RemoteAddress string

+ Route string

+ StatusCode int

+ UserAgent string

+ func ErrorMessage(err int64) ErrMsg

+ func ErrorMessageOK() ErrMsg

+ func NewErrorMessage(err int64) *ErrMsg

+ func NewErrorMessageWithArgs(err int64, base error, extra []string) *ErrMsg

+ func NewErrorMessageWithBase(err int64, base error) *ErrMsg

+ func (e *ErrMsg) LogString() string

+ type FormatHandler struct

+ Extension string

+ Handler http.Handler

+ type FormatHandlers []FormatHandler

+ type Handler func(*gorm.DB, http.ResponseWriter, *http.Request) *ErrMsg

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

+ type HandlerWithResult func(tx *gorm.DB, w http.ResponseWriter, r *http.Request) (interface{}, *ErrMsg)

+ type Header struct

+ HeaderDetails Detail

+ Name string

+ type JWTMiddlewareIgn struct

+ func (m *JWTMiddlewareIgn) AccessTokenHandler(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

+ type Logger interface

+ Clone func(reqID string) Logger

+ Critical func(interfaces ...interface{})

+ Debug func(interfaces ...interface{})

+ Error func(interfaces ...interface{})

+ Info func(interfaces ...interface{})

+ Warning func(interfaces ...interface{})

+ func LoggerFromContext(ctx context.Context) Logger

+ func LoggerFromRequest(r *http.Request) Logger

+ func NewLogger(reqID string, std bool, verbosity int) Logger

+ func NewLoggerNoRollbar(reqID string, verbosity int) Logger

+ func NewLoggerWithRollbarVerbosity(reqID string, std bool, verbosity, rollbarVerbosity int) Logger

+ type Method struct

+ Description string

+ Handlers FormatHandlers

+ Type string

+ type Methods []Method

+ type PaginationRequest struct

+ Page int64

+ PageRequested bool

+ PerPage int64

+ URL string

+ type PaginationResult struct

+ Page int64

+ PageFound bool

+ PerPage int64

+ QueryCount int64

+ URL string

+ func PaginateQuery(q *gorm.DB, result interface{}, p PaginationRequest) (*PaginationResult, error)

+ type ProtoResult HandlerWithResult

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

+ type Queue struct

+ func NewQueue() (queue *Queue)

+ func (st *Queue) Dequeue() (interface{}, *ErrMsg)

+ func (st *Queue) DequeueOrWaitForNextElement() (interface{}, *ErrMsg)

+ func (st *Queue) Enqueue(value interface{})

+ func (st *Queue) Find(criteria func(element interface{}) bool) []int

+ func (st *Queue) FindByIDs(ids []int) []interface{}

+ func (st *Queue) FindOne(target interface{}) int

+ func (st *Queue) GetCap() int

+ func (st *Queue) GetElement(index int) (interface{}, *ErrMsg)

+ func (st *Queue) GetElements() ([]interface{}, *ErrMsg)

+ func (st *Queue) GetFilteredElements(offset, limit int) ([]interface{}, *ErrMsg)

+ func (st *Queue) GetLen() int

+ func (st *Queue) MoveToBack(target interface{}) *ErrMsg

+ func (st *Queue) MoveToFront(target interface{}) *ErrMsg

+ func (st *Queue) Remove(target interface{}) *ErrMsg

+ func (st *Queue) Swap(a interface{}, b interface{}) *ErrMsg

+ type Repository interface

+ Add func(entity interface{}) (interface{}, *ErrMsg)

+ Clear func() *ErrMsg

+ Count func(criteria func(element interface{}) bool) int

+ Find func(criteria func(element interface{}) bool) ([]interface{}, *ErrMsg)

+ FindByIDs func(ids []interface{}) ([]interface{}, *ErrMsg)

+ FindOne func(criteria func(element interface{}) bool) (interface{}, *ErrMsg)

+ Get func(id interface{}) (interface{}, *ErrMsg)

+ GetAll func(offset, limit *int) ([]interface{}, *ErrMsg)

+ Remove func(id interface{}) (interface{}, *ErrMsg)

+ Update func(id interface{}, entity interface{}) (interface{}, *ErrMsg)

+ type Route struct

+ Description string

+ Headers []Header

+ Methods Methods

+ Name string

+ SecureMethods SecureMethods

+ URI string

+ type RouterConfigurer struct

+ func NewRouterConfigurer(r *mux.Router, monitoring monitoring.Provider) *RouterConfigurer

+ func (rc *RouterConfigurer) ConfigureRouter(pathPrefix string, routes Routes) *RouterConfigurer

+ func (rc *RouterConfigurer) SetAuthHandlers(optionalJWT, requiredJWT negroni.HandlerFunc) *RouterConfigurer

+ func (rc *RouterConfigurer) SetCustomHandlers(handlers ...negroni.Handler) *RouterConfigurer

+ type Routes []Route

+ type SecureMethods []Method

+ type Server struct

+ Db *gorm.DB

+ DbConfig DatabaseConfig

+ GaAppName string

+ GaCategoryPrefix string

+ GaTrackingID string

+ HTTPPort string

+ IsTest bool

+ LogToStd bool

+ LogVerbosity int

+ RollbarLogVerbosity int

+ Router *mux.Router

+ SSLCert string

+ SSLKey string

+ SSLport string

+ UsersDb *gorm.DB

+ func Init(auth0RSAPublicKey string, dbNameSuffix string, monitoring monitoring.Provider) (server *Server, err error)

+ func (s *Server) Auth0RsaPublicKey() string

+ func (s *Server) ConfigureRouterWithRoutes(pathPrefix string, router *mux.Router, routes Routes)

+ func (s *Server) IsUsingSSL() bool

+ func (s *Server) Run()

+ func (s *Server) SetAuth0RsaPublicKey(key string)

+ func (s *Server) SetRouter(router *mux.Router) *Server

+ type TypeJSONResult struct

+ func JSONListResult(wrapper string, handler HandlerWithResult) TypeJSONResult

+ func JSONResult(handler HandlerWithResult) TypeJSONResult

+ func JSONResultNoTx(handler HandlerWithResult) TypeJSONResult

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

Other modules containing this package

github.com/gazebo-web/gz-go/v10

github.com/gazebo-web/gz-go/v8

github.com/gazebo-web/gz-go/v9