protopreparsevalidation

Documentation

Index

• type RepeatedFieldLimitError
  • func (e *RepeatedFieldLimitError) Error() string
• type Validator
  • func Compile(root protoreflect.MessageDescriptor, fieldLimits map[protoreflect.FullName]int) (*Validator, error)
  • func (validator *Validator) Validate(message []byte) error

Types

type RepeatedFieldLimitError

type RepeatedFieldLimitError struct {
	Path  string
	Count int
	Limit int
}

func (*RepeatedFieldLimitError) Error

func (e *RepeatedFieldLimitError) Error() string

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

func Compile

func Compile(root protoreflect.MessageDescriptor, fieldLimits map[protoreflect.FullName]int) (*Validator, error)

The returned Validator is stateful and must not be used concurrently.

Assumptions and Limitations:

• No recursive schemas: the compiler rejects cyclic message descriptor graphs.
• No map fields: map fields are rejected at compile time because their wire representation (repeated synthetic entry messages) would require special handling, and we don't use them in our schemas.
• No repeated packable scalars (except bool): packed encoding merges multiple values into a single length-delimited record, making wire-level element counting inaccurate. Rather than adding complexity, we forbid these field types.
• No field numbers above maxAllowedFieldNumber to keep memory footprint small.
• See also the comment on Validator.

func (*Validator) Validate

func (validator *Validator) Validate(message []byte) error

Validate scans each message slice once, enforcing repeated-field limits and recursively validating bounded nested message subtrees before full unmarshal.