core

package

Go to main page

Versions in this module

v0

v0.18.1

Apr 30, 2024

v0.18.0

Apr 20, 2024

Changes in this version

type Core

+ func (c *Core) DecodeTo(req *http.Request, value any) (err error)

v0.17.0

Mar 15, 2024

v0.16.0

Jan 28, 2024

Changes in this version

+ var ErrTypeMismatch = internal.ErrTypeMismatch

+ var ErrUnregisteredCoder = errors.New("unregistered coder")

+ var ErrUnregisteredDirective = errors.New("unregistered directive")

+ var ErrUnsupportedType = owl.ErrUnsupportedType

v0.15.3

Jan 14, 2024

Changes in this version

+ var ErrUnknownBodyFormat = errors.New("unknown body format")

v0.15.2

Dec 31, 2023

v0.15.1

Dec 31, 2023

Changes in this version

type RequestBuilder

+ func NewRequestBuilder() *RequestBuilder

v0.15.0

Dec 31, 2023

Changes in this version

+ const CtxCustomCoder

+ const CtxFieldSet

+ const CtxRequest

+ const CtxRequestBuilder

+ func EnableNestedDirectives(on bool)

+ func IsPatchField(t reflect.Type) bool

+ func RegisterBodyFormat(format string, body BodySerializer, force ...bool)

+ func RegisterCoder[T any](adapt func(*T) (Stringable, error))

+ func RegisterDirective(name string, executor DirectiveExecutor, force ...bool)

+ func RegisterErrorHandler(handler ErrorHandler)

+ func RegisterFileCoder[T Fileable]() error

+ func RegisterNamedCoder[T any](name string, adapt func(*T) (Stringable, error))

+ type AnyStringableAdaptor = internal.AnyStringableAdaptor

+ type BodySerializer interface

+ Decode func(src io.Reader, dst any) error

+ Encode func(src any) (io.Reader, error)

+ type Core struct

+ func New(inputStruct any, opts ...Option) (*Core, error)

+ func (c *Core) Decode(req *http.Request) (any, error)

+ func (c *Core) GetErrorHandler() ErrorHandler

+ func (c *Core) NewRequest(method string, url string, input any) (*http.Request, error)

+ func (c *Core) NewRequestWithContext(ctx context.Context, method string, url string, input any) (*http.Request, error)

+ type DirectiveBody struct

+ func (db *DirectiveBody) Decode(rtm *DirectiveRuntime) error

+ func (db *DirectiveBody) Encode(rtm *DirectiveRuntime) error

+ type DirectiveDefault struct

+ func (*DirectiveDefault) Decode(rtm *DirectiveRuntime) error

+ func (*DirectiveDefault) Encode(rtm *DirectiveRuntime) error

+ type DirectiveExecutor interface

+ Decode func(*DirectiveRuntime) error

+ Encode func(*DirectiveRuntime) error

+ type DirectiveHeader struct

+ func (*DirectiveHeader) Decode(rtm *DirectiveRuntime) error

+ func (*DirectiveHeader) Encode(rtm *DirectiveRuntime) error

+ type DirectiveNonzero struct

+ func (*DirectiveNonzero) Decode(rtm *DirectiveRuntime) error

+ func (*DirectiveNonzero) Encode(rtm *DirectiveRuntime) error

+ type DirectivePath struct

+ func NewDirectivePath(decodeFunc func(*DirectiveRuntime) error) *DirectivePath

+ func (*DirectivePath) Encode(rtm *DirectiveRuntime) error

+ func (dir *DirectivePath) Decode(rtm *DirectiveRuntime) error

+ type DirectiveQuery struct

+ func (*DirectiveQuery) Decode(rtm *DirectiveRuntime) error

+ func (*DirectiveQuery) Encode(rtm *DirectiveRuntime) error

+ type DirectiveRequired struct

+ func (*DirectiveRequired) Decode(rtm *DirectiveRuntime) error

+ func (*DirectiveRequired) Encode(rtm *DirectiveRuntime) error

+ type DirectiveRuntime owl.DirectiveRuntime

+ func (rtm *DirectiveRuntime) GetCustomCoder() *NamedAnyStringableAdaptor

+ func (rtm *DirectiveRuntime) GetRequest() *http.Request

+ func (rtm *DirectiveRuntime) GetRequestBuilder() *RequestBuilder

+ func (rtm *DirectiveRuntime) IsFieldSet() bool

+ func (rtm *DirectiveRuntime) MarkFieldSet(value bool)

+ func (rtm *DirectiveRuntime) SetValue(value any) error

+ type DirectvieForm struct

+ func (*DirectvieForm) Decode(rtm *DirectiveRuntime) error

+ func (*DirectvieForm) Encode(rtm *DirectiveRuntime) error

+ type ErrorHandler = func(w http.ResponseWriter, r *http.Request, err error)

+ type File struct

+ func UploadFile(filename string) *File

+ func UploadStream(contentReader io.ReadCloser) *File

+ func (f *File) Filename() string

+ func (f *File) IsUpload() bool

+ func (f *File) MarshalFile() (io.ReadCloser, error)

+ func (f *File) OpenReceiveStream() (multipart.File, error)

+ func (f *File) OpenUploadStream() (io.ReadCloser, error)

+ func (f *File) ReadAll() ([]byte, error)

+ func (f *File) UnmarshalFile(fh FileHeader) error

+ type FileHeader interface

+ Filename func() string

+ MIMEHeader func() textproto.MIMEHeader

+ Open func() (multipart.File, error)

+ Size func() int64

+ type FileMarshaler interface

+ Filename func() string

+ MarshalFile func() (io.ReadCloser, error)

+ type FileSlicable interface

+ FromFileSlice func([]FileHeader) error

+ ToFileSlice func() ([]FileMarshaler, error)

+ func NewFileSlicable(rv reflect.Value) (FileSlicable, error)

+ type FileSlicablePatchFieldWrapper struct

+ Value reflect.Value

+ func NewFileSlicablePatchFieldWrapper(rv reflect.Value) (*FileSlicablePatchFieldWrapper, error)

+ func (w *FileSlicablePatchFieldWrapper) FromFileSlice(fhs []FileHeader) error

+ func (w *FileSlicablePatchFieldWrapper) ToFileSlice() ([]FileMarshaler, error)

+ type FileSlicableSingleFileableWrapper struct

+ func NewFileSlicableSingleFileableWrapper(rv reflect.Value) (*FileSlicableSingleFileableWrapper, error)

+ func (w *FileSlicableSingleFileableWrapper) FromFileSlice(files []FileHeader) error

+ func (w *FileSlicableSingleFileableWrapper) ToFileSlice() ([]FileMarshaler, error)

+ type FileUnmarshaler interface

+ UnmarshalFile func(FileHeader) error

+ type Fileable interface

+ func NewFileable(rv reflect.Value) (Fileable, error)

+ type FileablePatchFieldWrapper struct

+ Value reflect.Value

+ func NewFileablePatchFieldWrapper(rv reflect.Value) (*FileablePatchFieldWrapper, error)

+ func (w *FileablePatchFieldWrapper) Filename() string

+ func (w *FileablePatchFieldWrapper) MarshalFile() (io.ReadCloser, error)

+ func (w *FileablePatchFieldWrapper) UnmarshalFile(fh FileHeader) error

+ type FileableSliceWrapper struct

+ Value reflect.Value

+ func NewFileableSliceWrapper(rv reflect.Value) (*FileableSliceWrapper, error)

+ func (w *FileableSliceWrapper) FromFileSlice(fhs []FileHeader) error

+ func (w *FileableSliceWrapper) ToFileSlice() ([]FileMarshaler, error)

+ type FormEncoder struct

+ Setter func(key string, value []string)

+ func (e *FormEncoder) Execute(rtm *DirectiveRuntime) error

+ type FormExtractor struct

+ KeyNormalizer func(string) string

+ Runtime *DirectiveRuntime

+ func (e *FormExtractor) Extract(keys ...string) error

+ type HybridCoder struct

+ func (c *HybridCoder) FromString(s string) error

+ func (c *HybridCoder) ToString() (string, error)

+ type InvalidFieldError struct

+ Directive string

+ ErrorMessage string

+ Field string

+ Key string

+ Value any

+ func NewInvalidFieldError(err error) *InvalidFieldError

+ func (e *InvalidFieldError) Error() string

+ func (e *InvalidFieldError) Unwrap() error

+ type JSONBody struct

+ func (de *JSONBody) Decode(src io.Reader, dst any) error

+ func (en *JSONBody) Encode(src any) (io.Reader, error)

+ type MultiInvalidFieldError []*InvalidFieldError

+ func (me MultiInvalidFieldError) Error() string

+ func (me MultiInvalidFieldError) Unwrap() []error

+ type NamedAnyStringableAdaptor struct

+ Adapt AnyStringableAdaptor

+ BaseType reflect.Type

+ Name string

+ type Option func(*Core) error

+ func WithErrorHandler(custom ErrorHandler) Option

+ func WithMaxMemory(maxMemory int64) Option

+ func WithNestedDirectivesEnabled(enable bool) Option

+ type RequestBuilder struct

+ Attachment map[string][]FileMarshaler

+ Body io.ReadCloser

+ BodyType string

+ Cookie []*http.Cookie

+ Form url.Values

+ Header http.Header

+ Path map[string]string

+ Query url.Values

+ func (rb *RequestBuilder) Populate(req *http.Request) error

+ func (rb *RequestBuilder) SetAttachment(key string, files []FileMarshaler)

+ func (rb *RequestBuilder) SetBody(bodyType string, bodyReader io.ReadCloser)

+ func (rb *RequestBuilder) SetForm(key string, value []string)

+ func (rb *RequestBuilder) SetHeader(key string, value []string)

+ func (rb *RequestBuilder) SetPath(key string, value []string)

+ func (rb *RequestBuilder) SetQuery(key string, value []string)

+ type StringSlicable interface

+ FromStringSlice func([]string) error

+ ToStringSlice func() ([]string, error)

+ func NewStringSlicable(rv reflect.Value, adapt AnyStringableAdaptor) (StringSlicable, error)

+ type StringSlicablePatchFieldWrapper struct

+ Value reflect.Value

+ func NewStringSlicablePatchFieldWrapper(rv reflect.Value, adapt AnyStringableAdaptor) (*StringSlicablePatchFieldWrapper, error)

+ func (w *StringSlicablePatchFieldWrapper) FromStringSlice(values []string) error

+ func (w *StringSlicablePatchFieldWrapper) ToStringSlice() ([]string, error)

+ type StringSlicableSingleStringableWrapper struct

+ func NewStringSlicableSingleStringableWrapper(rv reflect.Value, adapt AnyStringableAdaptor) (*StringSlicableSingleStringableWrapper, error)

+ func (w *StringSlicableSingleStringableWrapper) FromStringSlice(values []string) error

+ func (w *StringSlicableSingleStringableWrapper) ToStringSlice() ([]string, error)

+ type Stringable = internal.Stringable

+ func NewStringable(rv reflect.Value, adapt AnyStringableAdaptor) (stringable Stringable, err error)

+ type StringablePatchFieldWrapper struct

+ Value reflect.Value

+ func NewStringablePatchFieldWrapper(rv reflect.Value, adapt AnyStringableAdaptor) (*StringablePatchFieldWrapper, error)

+ func (w *StringablePatchFieldWrapper) FromString(s string) error

+ func (w *StringablePatchFieldWrapper) ToString() (string, error)

+ type StringableSlice []Stringable

+ func (sa StringableSlice) FromStringSlice(values []string) error

+ func (sa StringableSlice) ToStringSlice() ([]string, error)

+ type StringableSliceWrapper struct

+ Adapt AnyStringableAdaptor

+ Value reflect.Value

+ func NewStringableSliceWrapper(rv reflect.Value, adapt AnyStringableAdaptor) (*StringableSliceWrapper, error)

+ func (w *StringableSliceWrapper) FromStringSlice(ss []string) error

+ func (w *StringableSliceWrapper) ToStringSlice() ([]string, error)

+ type TypeKind int

+ const TypeKindPatchT

+ const TypeKindPatchTSlice

+ const TypeKindT

+ const TypeKindTSlice

+ func BaseTypeOf(valueType reflect.Type) (reflect.Type, TypeKind)

+ type XMLBody struct

+ func (de *XMLBody) Decode(src io.Reader, dst any) error

+ func (en *XMLBody) Encode(src any) (io.Reader, error)

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