StructValidator Type — gin Architecture

Architecture documentation for the StructValidator type/interface in binding.go from the gin codebase.

Type go

Entity Profile

Dependency Diagram

graph TD
  10d92000_aba8_fa87_241f_c2b22d1a97f1["StructValidator"]
  89f71d9f_3ee5_74a2_c038_924a7433e1bd["binding.go"]
  10d92000_aba8_fa87_241f_c2b22d1a97f1 -->|defined in| 89f71d9f_3ee5_74a2_c038_924a7433e1bd
  style 10d92000_aba8_fa87_241f_c2b22d1a97f1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

binding/binding.go lines 55–67

type StructValidator interface {
	// ValidateStruct can receive any kind of type and it should never panic, even if the configuration is not right.
	// If the received type is a slice|array, the validation should be performed travel on every element.
	// If the received type is not a struct or slice|array, any validation should be skipped and nil must be returned.
	// If the received type is a struct or pointer to a struct, the validation should be performed.
	// If the struct is not valid or the validation itself fails, a descriptive error should be returned.
	// Otherwise nil must be returned.
	ValidateStruct(any) error

	// Engine returns the underlying validator engine which powers the
	// StructValidator implementation.
	Engine() any
}

Defined In

binding/binding.go

Source

View on GitHub

Frequently Asked Questions

What is the StructValidator type?

StructValidator is a type/interface in the gin codebase, defined in binding/binding.go.

Where is StructValidator defined?

StructValidator is defined in binding/binding.go at line 55.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free