fieldmask

Documentation

Index

• Constants
• Variables
• func FieldMasksForType(item any, parent string) map[string]struct{}
• func ParseFieldMask(fieldMask string) ([]string, error)
• func ParseFieldMaskRequest(r *http.Request) ([]string, error)
• type InvalidFieldMaskError
  • func NewInvalidFieldMaskError(fieldMask []string) *InvalidFieldMaskError
  • func (e *InvalidFieldMaskError) Error() string

Constants

const (
	QueryParamFieldMask = "fields"
)

Variables

var (
	ErrFieldMaskMissing = errors.New("field mask query param is not set")
	ErrFieldMaskEmpty   = errors.New("field mask is empty")
	ErrInvalidFieldMask = errors.New("field mask is invalid: ")

	FieldMaskRe = regexp.MustCompile(`^(\*|(\w+\.)*\*?|\w+(\.\w+)*\*?)$`)
)

Functions

func FieldMasksForType

func FieldMasksForType(item any, parent string) map[string]struct{}

FieldMasksForType returns a map of JSON field names for the given struct type.

func ParseFieldMask

func ParseFieldMask(fieldMask string) ([]string, error)

ParseFieldMask parses and validates the field mask from the given string.

func ParseFieldMaskRequest

func ParseFieldMaskRequest(r *http.Request) ([]string, error)

ParseFieldMaskRequest parses and validates the field mask from the HTTP request's query parameters. It returns a slice of field masks or an error if the field mask is missing, empty, or invalid.

Types

type InvalidFieldMaskError

type InvalidFieldMaskError struct {
	FieldMask []string
}

func NewInvalidFieldMaskError

func NewInvalidFieldMaskError(fieldMask []string) *InvalidFieldMaskError

func (*InvalidFieldMaskError) Error

func (e *InvalidFieldMaskError) Error() string