rest

package module

Go to main page

Versions in this module

v3

v3.0.28

Jan 22, 2024

v3.0.27

Jan 16, 2024

Changes in this version

type ExecResult

+ func (r *ExecResult) Cleanup()

type ExecResultRow

+ func (r *ExecResultRow) IsEmpty() bool

v3.0.26

Jan 9, 2024

Changes in this version

+ var ByRowDefaultDelimiter = []byte

+ var ByRowDefautlBegin = []byte

+ var ByRowDefautlEnd = []byte

+ type RowData struct

+ Data any

+ Delimiter []byte

+ Prefix []byte

+ Suffix []byte

v3.0.25

Jan 8, 2024

Changes in this version

+ type ByRow struct

+ Begin []byte

+ Data []any

+ Delimiter []byte

+ End []byte

+ IsFinal bool

+ Prefix []byte

+ RowNum int

+ Suffix []byte

+ 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 ProcOptions

+ DBqueryRows *sqlx.Rows

+ ResultAsRows bool

v3.0.24

Dec 30, 2023

Changes in this version

+ func SetMaxShaperLen(n int)

type Info

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

v3.0.23

Dec 27, 2023

v3.0.22

Dec 22, 2023

Changes in this version

type ExecResult

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

+ func (r *ExecResult) Error() (err error)

type ExecResultRow

+ Message string

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

v3.0.21

Dec 15, 2023

Changes in this version

type ExecResultRow

+ Error error

+ Messages []string

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

type Info

+ ResultTuner FuncResultTuner

v3.0.20

Dec 12, 2023

Changes in this version

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

type Info

+ Error FuncError

v3.0.19

Dec 7, 2023

v3.0.18

Dec 7, 2023

v3.0.17

Nov 20, 2023

v3.0.16

Nov 8, 2023

Changes in this version

type ProcOptions

+ QueryParamsFound misc.BoolMap

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

v3.0.15

Sep 26, 2023

Changes in this version

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

v3.0.14

Sep 8, 2023

v3.0.13

Sep 5, 2023

v3.0.12

Aug 16, 2023

v3.0.11

Jul 9, 2023

Changes in this version

+ const ExecResultRowName

v3.0.10

Jun 26, 2023

v3.0.9

Jun 19, 2023

v3.0.8

Jun 19, 2023

v3.0.7

Jun 18, 2023

v3.0.6

Jun 18, 2023

v3.0.5

Jun 16, 2023

v3.0.4

Jun 13, 2023

v3.0.3

Jun 5, 2023

v3.0.2

Jun 4, 2023

v3.0.1

May 9, 2023

Changes in this version

+ const DefaultMaxCount

+ const DefaultMaxPeriod

+ const ExecResultName

+ 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 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 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 Start() (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 Enumerator func(path string, info *Info) (err error)

+ type ExecResult struct

+ AffectedRows uint64

+ Notice string

+ Rows []ExecResultRow

+ type ExecResultRow struct

+ GUID string

+ ID uint64

+ 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 Info struct

+ After FuncAfter

+ Before FuncBefore

+ CacheLifetime time.Duration

+ Config any

+ DBtype string

+ Description string

+ Flags path.Flags

+ Init FuncInit

+ Methods *path.Set

+ Name string

+ Path string

+ QueryPrefix string

+ Summary string

+ Tags []string

+ 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

+ 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

+ Notices *misc.Messages

+ Path string

+ PathParams any

+ Prefix string

+ QueryParams any

+ R *http.Request

+ RawBody []byte

+ RequestParams any

+ Scope string

+ Tail []string

+ W http.ResponseWriter

+ 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 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/v4

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