validate

Documentation

Overview

Package validate provides a simple way to validate and parse data from HTTP requests.

Index

• Constants
• func IsValidationError(err error) bool
• type Validate
  • func New() *Validate
  • func (v Validate) JSONBodyInto(body io.ReadCloser, destStructPtr any) error
  • func (v Validate) JSONBytesInto(data []byte, destStructPtr any) error
  • func (v Validate) JSONStrInto(data string, destStructPtr any) error
  • func (v Validate) URLSearchParamsInto(r *http.Request, destStructPtr any) error
  • func (v Validate) UnmarshalFromBytes(data []byte, destStructPtr any) error
  • func (v Validate) UnmarshalFromRequest(r *http.Request, destStructPtr any) error
  • func (v Validate) UnmarshalFromResponse(r *http.Response, destStructPtr any) error
  • func (v Validate) UnmarshalFromString(data string, destStructPtr any) error

Constants

const ValidationErrorPrefix = "validation error: "

Functions

func IsValidationError

func IsValidationError(err error) bool

IsValidationError returns true if the error is a validation error.

Types

type Validate

type Validate struct {
	Instance *validator.Validate
}

Validate is a wrapper around the go-playground/validator package. It provides methods for validating and parsing data from HTTP requests.

func New

func New() *Validate

New creates a new Validate instance.

func (Validate) JSONBodyInto

func (v Validate) JSONBodyInto(body io.ReadCloser, destStructPtr any) error

JSONBodyInto decodes the JSON body of an HTTP request into a struct and validates it.

func (Validate) JSONBytesInto

func (v Validate) JSONBytesInto(data []byte, destStructPtr any) error

JSONBytesInto decodes a byte slice containing JSON data into a struct and validates it.

func (Validate) JSONStrInto

func (v Validate) JSONStrInto(data string, destStructPtr any) error

JSONStrInto decodes a string containing JSON data into a struct and validates it.

func (Validate) URLSearchParamsInto

func (v Validate) URLSearchParamsInto(r *http.Request, destStructPtr any) error

URLSearchParamsInto parses the URL parameters of an HTTP request into a struct and validates it.

func (Validate) UnmarshalFromBytes

func (v Validate) UnmarshalFromBytes(data []byte, destStructPtr any) error

Deprecated: UnmarshalFromBytes is deprecated. Use JSONBytesInto instead.

func (Validate) UnmarshalFromRequest

func (v Validate) UnmarshalFromRequest(r *http.Request, destStructPtr any) error

Deprecated: UnmarshalFromRequest is deprecated. Use `v.JSONBodyInto(r.Body, dest)` instead.

func (Validate) UnmarshalFromResponse

func (v Validate) UnmarshalFromResponse(r *http.Response, destStructPtr any) error

Deprecated: UnmarshalFromResponse is deprecated. Use `v.JSONBodyInto(r.Body, dest)` instead.

func (Validate) UnmarshalFromString

func (v Validate) UnmarshalFromString(data string, destStructPtr any) error

Deprecated: UnmarshalFromString is deprecated. Use JSONStrInto instead.