rest

package module

Go to main page

Versions in this module

v4

v4.0.14

May 14, 2024

v4.0.13

Apr 11, 2024

v4.0.12

Apr 3, 2024

Changes in this version

+ func Forbidden(msg string, v ...any) (code int, err error)

v4.0.11

Mar 20, 2024

v4.0.10

Mar 14, 2024

v4.0.9

Mar 1, 2024

Changes in this version

+ const EmptyGUID

v4.0.8

Feb 21, 2024

Changes in this version

type ExecResultRow

+ func (r *ExecResultRow) GetCode() (code int)

+ func (r *ExecResultRow) SetCode(code int)

v4.0.7

Feb 15, 2024

Changes in this version

type ProcOptions

+ AuthIdentity *auth.Identity

v4.0.6

Feb 9, 2024

Changes in this version

type ExecResult

+ func NewExecResult() *ExecResult

type ExecResultRow

+ func NewExecResultRow() *ExecResultRow

v4.0.5

Feb 9, 2024

Changes in this version

type ExecResult

+ func (execResult *ExecResult) DbResultParser(stdExecResult *db.Result, returnsObj *[]*ExecResultRow) (err error)

+ func (execResult *ExecResult) MultiDefer(pResult *any, pCode *int, pErr *error)

v4.0.4

Feb 9, 2024

v4.0.3

Feb 8, 2024

v4.0.2

Feb 8, 2024

Changes in this version

+ const ErrorResultName

v4.0.1

Feb 8, 2024

Changes in this version

type ExecResult

+ Method string

v4.0.0

Feb 7, 2024

Changes in this version

+ const DefaultMaxCount

+ const DefaultMaxPeriod

+ const ExecResultName

+ const ExecResultRowName

+ const ExprGUID

+ const ExprID

+ const ExprName

+ const ExprPattern

+ const FlagConvertReplyToJSON

+ const FlagLogUnknownParams

+ const ParamCount

+ const ParamIDs

+ const ParamNames

+ const ParamPeriodFrom

+ const ParamPeriodTo

+ const REany

+ const REempty

+ const REguid

+ const REid

+ const REstatus

+ const ScopeDeleteGUID

+ const ScopeDeleteID

+ const ScopeDeleteName

+ const ScopeInsert

+ const ScopeSelectAll

+ const ScopeSelectGUID

+ const ScopeSelectID

+ const ScopeSelectName

+ const ScopeSelectPattern

+ const ScopeSelectStatus

+ const ScopeUpdateGUID

+ const ScopeUpdateID

+ const ScopeUpdateName

+ const StatusActive

+ const StatusInactive

+ const StatusProcessed

+ const StatusRetry

+ var ByRowDefaultDelimiter = []byte

+ var ByRowDefautlBegin = []byte

+ var ByRowDefautlEnd = []byte

+ var Log = log.NewFacility("api")

+ func AddTag(tag *Tag) error

+ func BadRequest(msg string, v ...any) (code int, err error)

+ func CheckPeriod(from time.Time, to time.Time, maxPeriod time.Duration, stdPeriod time.Duration) (normFrom time.Time, normTo time.Time, code int, err error)

+ func DelSubstArg(vars []any, name string) (result []any)

+ func Enumerate(e Enumerator) (err error)

+ func FindSubstArg(vars []any, name string) (subst *db.SubstArg)

+ func GetTagName(name string) string

+ func Handler(h *stdhttp.HTTP, id uint64, prefix string, urlPath string, ...) (basePath string, processed bool)

+ func HandlerEx(find FindModule, extra any, h *stdhttp.HTTP, id uint64, prefix string, ...) (basePath string, processed bool)

+ func Init(cfg any, hh *stdhttp.HTTP, basePath string, defaultDB string, ...) (err error)

+ func InternalServerError(msg string, v ...any) (code int, err error)

+ func ModuleRegistration(handler API) (err error)

+ func NotAllowed(msg string, v ...any) (code int, err error)

+ func NotFound(msg string, v ...any) (code int, err error)

+ func NotImplemented(msg string, v ...any) (code int, err error)

+ func ParseTime(s string) (t time.Time, err error)

+ func RemoveModuleRegistration(handler API) (err error)

+ func SetMaxShaperLen(n int)

+ func Start() (err error)

+ func UnprocessableEntity(msg string, v ...any) (code int, err error)

+ type API interface

+ After func(proc *ProcOptions) (result any, code int, err error)

+ Before func(proc *ProcOptions) (result any, code int, err error)

+ Info func() *Info

+ type ByRow struct

+ Begin []byte

+ Data []RowData

+ End []byte

+ IsFinal bool

+ RowNum int

+ func NewByRow(proc *ProcOptions, tuner ByRowTuner) (br *ByRow, err error)

+ func (br *ByRow) Close() (err error)

+ func (br *ByRow) Do() (err error)

+ func (br *ByRow) Flush() (err error)

+ func (br *ByRow) Write(p []byte) (n int, err error)

+ type ByRowTuner func(br *ByRow, row any) (err error)

+ type Enumerator func(path string, info *Info) (err error)

+ type ExecResult struct

+ FailedRows uint64

+ Rows []*ExecResultRow

+ SuccessRows uint64

+ TotalRows uint64

+ func (r *ExecResult) AddRow(row *ExecResultRow)

+ func (r *ExecResult) FillMessages()

+ type ExecResultRow struct

+ Code int

+ GUID string

+ ID uint64

+ func (r *ExecResultRow) AddError(err error)

+ func (r *ExecResultRow) AddErrors(errs []error)

+ func (r *ExecResultRow) AddMessage(s string, params ...any)

+ func (r *ExecResultRow) AddMessages(ss []string)

+ func (r *ExecResultRow) Errors() (err []error)

+ func (r *ExecResultRow) FillMessages()

+ func (r *ExecResultRow) HasErrors() bool

+ type ExternalDocs struct

+ Description string

+ URL string

+ type FieldDef struct

+ DBname string

+ JSONname string

+ Type reflect.Kind

+ type FindModule func(path string) (module *Module, basePath string, extraPath []string, found bool)

+ type FuncAfter func(proc *ProcOptions) (result any, code int, err error)

+ type FuncBefore func(proc *ProcOptions) (result any, code int, err error)

+ type FuncInit func(info *Info) (err error)

+ type FuncResultTuner func(proc *ProcOptions, result0 any, code0 int, err0 error) (result any, code int, err error)

+ type Info struct

+ After FuncAfter

+ Before FuncBefore

+ Config any

+ DBtype string

+ Description string

+ Flags path.Flags

+ Init FuncInit

+ Methods *path.Set

+ Name string

+ Path string

+ QueryPrefix string

+ ResultTuner FuncResultTuner

+ Summary string

+ Tags []string

+ func (info *Info) ShaperWorkers(n int) (err error)

+ type MessagesBlock struct

+ Messages []string

+ func (m *MessagesBlock) AddError(err error)

+ func (m *MessagesBlock) AddErrors(errs []error)

+ func (m *MessagesBlock) AddMessage(s string, params ...any)

+ func (m *MessagesBlock) AddMessages(ss []string)

+ func (m *MessagesBlock) Errors() (errs []error)

+ func (m *MessagesBlock) FillMessages()

+ func (m *MessagesBlock) HasErrors() bool

+ type Module struct

+ Handler API

+ Info *Info

+ LogFacility *log.Facility

+ RawURL string

+ RelativeURL string

+ type ProcOptions struct

+ Chain *path.Chain

+ ChainLocal path.Chain

+ Custom any

+ DBqueryName string

+ DBqueryResult any

+ DBqueryRows *sqlx.Rows

+ DBqueryVars []any

+ ExcludedFields misc.StringMap

+ ExecResult *ExecResult

+ Extra any

+ ExtraHeaders misc.StringMap

+ Fields []misc.InterfaceMap

+ H *stdhttp.HTTP

+ ID uint64

+ Info *Info

+ LogFacility *log.Facility

+ LogSrc string

+ Path string

+ PathParams any

+ Prefix string

+ QueryParams any

+ QueryParamsFound misc.BoolMap

+ R *http.Request

+ RawBody []byte

+ RequestParams any

+ ResultAsRows bool

+ Scope string

+ Tail []string

+ W http.ResponseWriter

+ func (po *ProcOptions) QueryParamFound(name string) bool

+ func (proc *ProcOptions) Create() (result any, code int, err error)

+ func (proc *ProcOptions) Delete() (result any, code int, err error)

+ func (proc *ProcOptions) Get() (result any, code int, err error)

+ func (proc *ProcOptions) Others() (result any, code int, err error)

+ func (proc *ProcOptions) Update() (result any, code int, err error)

+ type RowData struct

+ Data any

+ Delimiter []byte

+ Prefix []byte

+ Suffix []byte

+ type Tag struct

+ Aliases []string

+ Description string

+ ExternalDocs ExternalDocs

+ Name string

+ type Tags []*Tag

+ func GetTags() Tags

Other modules containing this package

github.com/alrusov/rest

github.com/alrusov/rest/v2

github.com/alrusov/rest/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL