shared

Documentation

Index

• func Disabled(msg pgs.Message) (disabled bool, err error)
• func Has(msg proto.Message, fld string) bool
• func Needs(m pgs.Message, wk WellKnown) bool
• func RegisterFunctions(tpl *template.Template)
• func Render(tpl *template.Template) func(ctx RuleContext) (string, error)
• func RequiredOneOf(oo pgs.OneOf) (required bool, err error)
• type RuleContext
  • func (ctx RuleContext) Elem(name, idx string) (out RuleContext, err error)
  • func (ctx RuleContext) Key(name, idx string) (out RuleContext, err error)
  • func (ctx RuleContext) Unwrap(name string) (out RuleContext, err error)
• type WellKnown

Functions

func Disabled

func Disabled(msg pgs.Message) (disabled bool, err error)

Disabled returns true if validations are disabled for msg

func Has

func Has(msg proto.Message, fld string) bool

Has returns true if the provided Message has the a field fld.

func Needs

func Needs(m pgs.Message, wk WellKnown) bool

Needs returns true if a well-known string validator is needed for this message.

func RegisterFunctions

func RegisterFunctions(tpl *template.Template)

func Render

func Render(tpl *template.Template) func(ctx RuleContext) (string, error)

func RequiredOneOf

func RequiredOneOf(oo pgs.OneOf) (required bool, err error)

RequiredOneOf returns true if the oneof field requires a field to be set

Types

type RuleContext

type RuleContext struct {
	Field pgs.Field
	Rules proto.Message

	Typ        string
	WrapperTyp string

	OnKey            bool
	Index            string
	AccessorOverride string
}

func (RuleContext) Elem

func (ctx RuleContext) Elem(name, idx string) (out RuleContext, err error)

func (RuleContext) Key

func (ctx RuleContext) Key(name, idx string) (out RuleContext, err error)

func (RuleContext) Unwrap

func (ctx RuleContext) Unwrap(name string) (out RuleContext, err error)

type WellKnown

type WellKnown string

const (
	Email    WellKnown = "email"
	Hostname WellKnown = "hostname"
)