rez

package module

Go to main page

Versions in this module

v0

v0.4.0

Apr 9, 2024

v0.3.4

Apr 7, 2024

Changes in this version

type Accepted

+ func (err Accepted[V]) APIName() string

+ func (err Accepted[V]) APISchemaType() any

type BadRequest

+ func (err BadRequest[V]) APIName() string

+ func (err BadRequest[V]) APISchemaType() any

type Conflict

+ func (err Conflict[V]) APIName() string

+ func (err Conflict[V]) APISchemaType() any

type Created

+ func (err Created[V]) APIName() string

+ func (err Created[V]) APISchemaType() any

type Forbidden

+ func (err Forbidden[V]) APIName() string

+ func (err Forbidden[V]) APISchemaType() any

type InternalServerError

+ func (err InternalServerError[V]) APIName() string

+ func (err InternalServerError[V]) APISchemaType() any

+ type Moved struct

+ Result V

+ func NewMoved[V any](result V) *Moved[V]

+ func (err *Moved[V]) UnmarshalJSON(data []byte) error

+ func (err Moved[V]) APIName() string

+ func (err Moved[V]) APISchemaType() any

+ func (err Moved[V]) HTTPStatus() int

+ func (err Moved[V]) HTTPStatuses() []int

+ func (err Moved[V]) MarshalJSON() ([]byte, error)

type NotFound

+ func (err NotFound[V]) APIName() string

+ func (err NotFound[V]) APISchemaType() any

type NotImplemented

+ func (err NotImplemented[V]) APIName() string

+ func (err NotImplemented[V]) APISchemaType() any

type OK

+ func (err OK[V]) APIName() string

+ func (err OK[V]) APISchemaType() any

+ type PaymentRequired struct

+ Result V

+ func NewPaymentRequired[V any](result V) *PaymentRequired[V]

+ func (err *PaymentRequired[V]) UnmarshalJSON(data []byte) error

+ func (err PaymentRequired[V]) APIName() string

+ func (err PaymentRequired[V]) APISchemaType() any

+ func (err PaymentRequired[V]) Error() string

+ func (err PaymentRequired[V]) HTTPStatus() int

+ func (err PaymentRequired[V]) HTTPStatuses() []int

+ func (err PaymentRequired[V]) MarshalJSON() ([]byte, error)

type Result

+ func (err Result[V]) APIName() string

+ func (err Result[V]) APISchemaType() any

type ServiceUnavailable

+ func (err ServiceUnavailable[V]) APIName() string

+ func (err ServiceUnavailable[V]) APISchemaType() any

type TooManyRequests

+ func (err TooManyRequests[V]) APIName() string

+ func (err TooManyRequests[V]) APISchemaType() any

type Unauthorized

+ func (err Unauthorized[V]) APIName() string

+ func (err Unauthorized[V]) APISchemaType() any

v0.3.3

Apr 5, 2024

v0.3.2

Apr 5, 2024

v0.3.1

Apr 3, 2024

v0.3.0

Apr 2, 2024

v0.2.2

Apr 2, 2024

v0.2.1

Apr 2, 2024

v0.2.0

Apr 2, 2024

Changes in this version

+ type RouterOperation interface

+ Input func(input ...any)

+ Operation func() *api.Operation

+ Output func(output ...any)

+ Router func() Router

+ type SiteOperation struct

+ func (op SiteOperation) Input(input ...any)

+ func (op SiteOperation) Operation() *api.Operation

+ func (op SiteOperation) Output(output ...any)

+ func (op SiteOperation) Router() Router

v0.1.0

Dec 1, 2022

Changes in this version

+ var ErrUnsupportedType = errors.New("unsupported type")

+ var ScopeKey = scopeKey

+ func Validate(givenSchema *api.Schema, rawValue any, v *Validator)

+ func ValidateInjectable(inj Injectable, scope *deps.Scope) error

+ type Accepted struct

+ Result V

+ func NewAccepted(result V) *Accepted[V]

+ func (err *Accepted[V]) UnmarshalJSON(data []byte) error

+ func (err Accepted[V]) Error() string

+ func (err Accepted[V]) HTTPStatus() int

+ func (err Accepted[V]) HTTPStatuses() []int

+ func (err Accepted[V]) MarshalJSON() ([]byte, error)

+ type BadRequest struct

+ Result V

+ func NewBadRequest(result V) *BadRequest[V]

+ func (err *BadRequest[V]) UnmarshalJSON(data []byte) error

+ func (err BadRequest[V]) Error() string

+ func (err BadRequest[V]) HTTPStatus() int

+ func (err BadRequest[V]) HTTPStatuses() []int

+ func (err BadRequest[V]) MarshalJSON() ([]byte, error)

+ type Body struct

+ Value B

+ func (b *Body[B]) ProvideDynamic(scope *deps.Scope) error

+ func (b Body[B]) APIRequestTypes() RequestTypes

+ func (p Body[B]) APIValidate(op *api.Operation, v *Validator)

+ type CanSend interface

+ HTTPSend func(w http.ResponseWriter) error

+ type CanValidateFull interface

+ FullValidate func(v *Validator)

+ type CanValidatePost interface

+ PostValidate func(v *Validator)

+ type Conflict struct

+ Result V

+ func NewConflict(result V) *Conflict[V]

+ func (err *Conflict[V]) UnmarshalJSON(data []byte) error

+ func (err Conflict[V]) Error() string

+ func (err Conflict[V]) HTTPStatus() int

+ func (err Conflict[V]) HTTPStatuses() []int

+ func (err Conflict[V]) MarshalJSON() ([]byte, error)

+ type Created struct

+ Result V

+ func NewCreated(result V) *Created[V]

+ func (err *Created[V]) UnmarshalJSON(data []byte) error

+ func (err Created[V]) Error() string

+ func (err Created[V]) HTTPStatus() int

+ func (err Created[V]) HTTPStatuses() []int

+ func (err Created[V]) MarshalJSON() ([]byte, error)

+ type ErrorHandler = func(err error, response http.ResponseWriter, request *http.Request, ...) (bool, error)

+ type Forbidden struct

+ Result V

+ func NewForbidden(result V) *Forbidden[V]

+ func (err *Forbidden[V]) UnmarshalJSON(data []byte) error

+ func (err Forbidden[V]) Error() string

+ func (err Forbidden[V]) HTTPStatus() int

+ func (err Forbidden[V]) HTTPStatuses() []int

+ func (err Forbidden[V]) MarshalJSON() ([]byte, error)

+ type HandledError interface

+ Handle func(response http.ResponseWriter, request *http.Request, scope *deps.Scope) error

+ type HasContentType interface

+ HTTPContentType func() string

+ type HasStatus interface

+ HTTPStatus func() int

+ HTTPStatuses func() []int

+ type Header struct

+ Value H

+ func (h Header[H]) APIRequestTypes() RequestTypes

+ func (h Header[H]) APIValidate(op *api.Operation, v *Validator)

+ func (r *Header[H]) ProvideDynamic(scope *deps.Scope) error

+ type Injectable interface

+ APIRequestTypes func() RequestTypes

+ APIValidate func(op *api.Operation, v *Validator)

+ type InternalErrorHandler = func(err error)

+ type InternalServerError struct

+ Result V

+ func NewInternalServerError(result V) *InternalServerError[V]

+ func (err *InternalServerError[V]) UnmarshalJSON(data []byte) error

+ func (err InternalServerError[V]) Error() string

+ func (err InternalServerError[V]) HTTPStatus() int

+ func (err InternalServerError[V]) HTTPStatuses() []int

+ func (err InternalServerError[V]) MarshalJSON() ([]byte, error)

+ type MiddlewareNext func()

+ func NewMiddlewareNext(h http.Handler, scope *deps.Scope) MiddlewareNext

+ type None struct

+ type NotFound struct

+ Result V

+ func NewNotFound(result V) *NotFound[V]

+ func (err *NotFound[V]) UnmarshalJSON(data []byte) error

+ func (err NotFound[V]) Error() string

+ func (err NotFound[V]) HTTPStatus() int

+ func (err NotFound[V]) HTTPStatuses() []int

+ func (err NotFound[V]) MarshalJSON() ([]byte, error)

+ type NotImplemented struct

+ Result V

+ func NewNotImplemented(result V) *NotImplemented[V]

+ func (err *NotImplemented[V]) UnmarshalJSON(data []byte) error

+ func (err NotImplemented[V]) Error() string

+ func (err NotImplemented[V]) HTTPStatus() int

+ func (err NotImplemented[V]) HTTPStatuses() []int

+ func (err NotImplemented[V]) MarshalJSON() ([]byte, error)

+ type OK struct

+ Result V

+ func NewOK(result V) *OK[V]

+ func (err *OK[V]) UnmarshalJSON(data []byte) error

+ func (err OK[V]) Error() string

+ func (err OK[V]) HTTPStatus() int

+ func (err OK[V]) HTTPStatuses() []int

+ func (err OK[V]) MarshalJSON() ([]byte, error)

+ type Path struct

+ Value P

+ func (p Path[P]) APIRequestTypes() RequestTypes

+ func (p Path[P]) APIValidate(op *api.Operation, v *Validator)

+ func (r *Path[P]) ProvideDynamic(scope *deps.Scope) error

+ type Query struct

+ Value Q

+ func (p Query[Q]) APIValidate(op *api.Operation, v *Validator)

+ func (q Query[Q]) APIRequestTypes() RequestTypes

+ func (r *Query[Q]) ProvideDynamic(scope *deps.Scope) error

+ type Request struct

+ Body B

+ Path P

+ Query Q

+ func (p Request[B, P, Q]) APIValidate(op *api.Operation, v *Validator)

+ func (r *Request[B, P, Q]) ProvideDynamic(scope *deps.Scope) error

+ func (r Request[B, P, Q]) APIRequestTypes() RequestTypes

+ type RequestTypes struct

+ Body reflect.Type

+ Header reflect.Type

+ Path reflect.Type

+ Query reflect.Type

+ type Result struct

+ Status int

+ Value V

+ func NewResult(status int, result V) *Result[V]

+ func (se *Result[V]) UnmarshalJSON(data []byte) error

+ func (se Result[V]) HTTPStatus() int

+ func (se Result[V]) HTTPStatuses() []int

+ func (se Result[V]) MarshalJSON() ([]byte, error)

+ type Router interface

+ AddResponse func(code string, response api.Response)

+ AddResponses func(responses api.Responses)

+ AddTags func(tags []string)

+ Chi func() chi.Router

+ Connect func(pattern string, fn any)

+ CreatePath func(pattern string) *api.Path

+ DefineBody func(bodies ...any)

+ DefineHeader func(headers ...any)

+ DefinePath func(params ...any)

+ DefineQuery func(queries ...any)

+ Delete func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ EnableValidation func(enabled bool)

+ Get func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ GetOperations func() *api.Operation

+ GetPath func(pattern string) *api.Path

+ GetScope func(response http.ResponseWriter, request *http.Request) *deps.Scope

+ Group func(fn func(r Router)) Router

+ HandleError func(err error, response http.ResponseWriter, request *http.Request, ...) error

+ HandleFunc func(pattern string, fn any, operations ...api.Operation) *api.Path

+ Head func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ MethodFunc func(method, pattern string, fn any, operations ...api.Operation) *api.Operation

+ MethodNotAllowed func(fn any)

+ NotFound func(fn any)

+ Options func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ Patch func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ Post func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ Put func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ Route func(pattern string, fn func(r Router)) Router

+ SetErrorHandler func(handler ErrorHandler)

+ SetInternalErrorHandler func(handle InternalErrorHandler)

+ SetOperations func(op api.Operation)

+ SetResponses func(responses api.Responses)

+ SetTags func(tags []string)

+ SetValidationOptions func(valueOrType any, options ValidationOptions)

+ Trace func(pattern string, fn any, operations ...api.Operation) *api.Operation

+ URL func() string

+ UpdateOperations func(op api.Operation)

+ UpdatePath func(pattern string, path api.Path)

+ Use func(middlewares ...any)

+ With func(middlewares ...any) Router

+ type ServiceUnavailable struct

+ Result V

+ func NewServiceUnavailable(result V) *ServiceUnavailable[V]

+ func (err *ServiceUnavailable[V]) UnmarshalJSON(data []byte) error

+ func (err ServiceUnavailable[V]) Error() string

+ func (err ServiceUnavailable[V]) HTTPStatus() int

+ func (err ServiceUnavailable[V]) HTTPStatuses() []int

+ func (err ServiceUnavailable[V]) MarshalJSON() ([]byte, error)

+ type Site struct

+ Open *api.Builder

+ Scope *deps.Scope

+ ServeJSON bool

+ ServeXML bool

+ func New(router chi.Router) *Site

+ func (site *Site) AddResponse(code string, response api.Response)

+ func (site *Site) AddResponses(responses api.Responses)

+ func (site *Site) AddTags(tags []string)

+ func (site *Site) BuildDocument() *api.Document

+ func (site *Site) BuildJSON() []byte

+ func (site *Site) Connect(pattern string, fn any)

+ func (site *Site) CreatePath(pattern string) *api.Path

+ func (site *Site) DefineBody(bodies ...any)

+ func (site *Site) DefineHeader(bodies ...any)

+ func (site *Site) DefinePath(paths ...any)

+ func (site *Site) DefineQuery(bodies ...any)

+ func (site *Site) Delete(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) EnableValidation(enabled bool)

+ func (site *Site) Get(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) GetOperations() *api.Operation

+ func (site *Site) GetPath(pattern string) *api.Path

+ func (site *Site) GetScope(response http.ResponseWriter, request *http.Request) *deps.Scope

+ func (site *Site) Group(fn func(r Router)) Router

+ func (site *Site) HandleError(err error, response http.ResponseWriter, request *http.Request, ...) error

+ func (site *Site) HandleFunc(pattern string, fn any, operations ...api.Operation) *api.Path

+ func (site *Site) Head(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) Listen(addr string)

+ func (site *Site) MethodFunc(method string, pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) MethodNotAllowed(fn any)

+ func (site *Site) NotFound(fn any)

+ func (site *Site) Options(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) Patch(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) Post(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) PrintPaths()

+ func (site *Site) Put(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) Route(pattern string, fn func(r Router)) Router

+ func (site *Site) Run()

+ func (site *Site) Send(response any, w http.ResponseWriter) error

+ func (site *Site) SendAny(response []byte, w http.ResponseWriter, status int, ...)

+ func (site *Site) ServeOpenJSON(pattern string)

+ func (site *Site) ServeRedoc(pattern string)

+ func (site *Site) ServeSwaggerUI(pattern string, options map[string]any)

+ func (site *Site) SetErrorHandler(handler ErrorHandler)

+ func (site *Site) SetInternalErrorHandler(handle InternalErrorHandler)

+ func (site *Site) SetOperations(op api.Operation)

+ func (site *Site) SetResponses(responses api.Responses)

+ func (site *Site) SetTags(tags []string)

+ func (site *Site) SetValidationOptions(valueOrType any, options ValidationOptions)

+ func (site *Site) Trace(pattern string, fn any, operations ...api.Operation) *api.Operation

+ func (site *Site) UpdateOperations(op api.Operation)

+ func (site *Site) UpdatePath(pattern string, path api.Path)

+ func (site *Site) Use(fns ...any)

+ func (site *Site) With(fns ...any) Router

+ func (site Site) Chi() chi.Router

+ func (site Site) URL() string

+ func (site Site) ValidationOptions(typ reflect.Type) ValidationOptions

+ type TooManyRequests struct

+ Result V

+ func NewTooManyRequests(result V) *TooManyRequests[V]

+ func (err *TooManyRequests[V]) UnmarshalJSON(data []byte) error

+ func (err TooManyRequests[V]) Error() string

+ func (err TooManyRequests[V]) HTTPStatus() int

+ func (err TooManyRequests[V]) HTTPStatuses() []int

+ func (err TooManyRequests[V]) MarshalJSON() ([]byte, error)

+ type Unauthorized struct

+ Result V

+ func NewUnauthorized(result V) *Unauthorized[V]

+ func (err *Unauthorized[V]) UnmarshalJSON(data []byte) error

+ func (err Unauthorized[V]) Error() string

+ func (err Unauthorized[V]) HTTPStatus() int

+ func (err Unauthorized[V]) HTTPStatuses() []int

+ func (err Unauthorized[V]) MarshalJSON() ([]byte, error)

+ type Validation struct

+ Message string

+ Path []string

+ Rule ValidationRule

+ Schema *string

+ type ValidationOptions struct

+ EnforceFormat bool

+ FailDeprecated bool

+ Skip bool

+ SkipDeprecated bool

+ type ValidationProvider interface

+ ValidationOptions func(reflect.Type) ValidationOptions

+ type ValidationRule string

+ const ValidationRuleAllOf

+ const ValidationRuleAnyOf

+ const ValidationRuleCustom

+ const ValidationRuleDeprecated

+ const ValidationRuleEnum

+ const ValidationRuleFormat

+ const ValidationRuleMaxItems

+ const ValidationRuleMaxLength

+ const ValidationRuleMaxProperties

+ const ValidationRuleMaximum

+ const ValidationRuleMinItems

+ const ValidationRuleMinLength

+ const ValidationRuleMinProperties

+ const ValidationRuleMinimum

+ const ValidationRuleMultipleOf

+ const ValidationRuleNot

+ const ValidationRuleNullable

+ const ValidationRuleOneOf

+ const ValidationRulePattern

+ const ValidationRuleRequired

+ const ValidationRuleType

+ const ValidationRuleUniqueItems

+ type Validator struct

+ Path []string

+ Provider ValidationProvider

+ Scope *deps.Scope

+ Validations *[]Validation

+ func NewValidator(provider ValidationProvider, scope *deps.Scope) *Validator

+ func (v *Validator) Add(msg Validation)

+ func (v *Validator) Attach(detached Validator)

+ func (v Validator) Detach() Validator

+ func (v Validator) Error() string

+ func (v Validator) HTTPStatus() int

+ func (v Validator) HTTPStatuses() []int

+ func (v Validator) HasFailures() bool

+ func (v Validator) IsValid() bool

+ func (v Validator) Next(path string) *Validator

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