variable

package

Go to main page

Versions in this module

v1

v1.6.1

Apr 6, 2026

v1.6.0

Apr 6, 2026

v1.5.1

Apr 10, 2025

v1.5.0

Apr 10, 2025

Changes in this version

type DependsOn

+ Value maybe.Value[Literal]

type OfType

+ TypedSpec *TypedSpec[T]

v1.4.0

Aug 16, 2024

Changes in this version

+ type ConstraintContext int

+ const ConstraintContextDefault

+ const ConstraintContextExample

+ const ConstraintContextFinal

v1.3.0

Mar 14, 2024

Changes in this version

type LengthLimited

+ LengthDescription func() string

type TypedBinary

+ func (s TypedBinary[T, B]) LengthDescription() string

type TypedString

+ func (s TypedString[T]) LengthDescription() string

v1.2.1

Aug 13, 2023

v1.2.0

Jun 11, 2023

Changes in this version

+ var DefaultRegistry = &Registry

+ func EstablishRelationships(relationships ...Relationship)

+ func InverseRelationships(s Spec) []T

+ func IsDefault(s Spec, v Literal) bool

+ func Relationships(s Spec) []T

+ func ResetDefaultRegistry()

+ func UnwrapNumericParseError(err error, format func(T) string) error

+ type Any interface

+ Availability func() Availability

+ Error func() Error

+ Source func() Source

+ Spec func() Spec

+ Value func() Value

+ type Availability int

+ const AvailabilityIgnored

+ const AvailabilityInvalid

+ const AvailabilityNone

+ const AvailabilityOK

+ type Binary interface

+ EncodingDescription func() string

+ type Constraint interface

+ Description func() string

+ IsUserDefined func() bool

+ type ConstraintError interface

+ type DependsOn struct

+ DependsOn Spec

+ Subject Spec

+ type Documentation struct

+ IsImportant bool

+ Paragraphs []string

+ Summary string

+ type DocumentationBuilder struct

+ func (b DocumentationBuilder) Done()

+ func (b DocumentationBuilder) Important() DocumentationBuilder

+ func (b DocumentationBuilder) Paragraph(text ...string) ParagraphFormatter

+ func (b DocumentationBuilder) Summary(summary string) DocumentationBuilder

+ type Error interface

+ Name func() string

+ type Example struct

+ Canonical Literal

+ Description string

+ IsNormative bool

+ Source ExampleSource

+ func BestExample(spec Spec) Example

+ type ExampleSource int

+ const ExampleSourceSchema

+ const ExampleSourceSpecBuilder

+ const ExampleSourceSpecDefault

+ const ExampleSourceUnknown

+ type LengthLimited interface

+ MaxLength func() (int, bool)

+ MinLength func() (int, bool)

+ type Literal struct

+ String string

+ func (l Literal) Quote() string

+ type Marshaler interface

+ Marshal func(T) (Literal, error)

+ Unmarshal func(Literal) (T, error)

+ type MaxError struct

+ Numeric Numeric

+ func (e MaxError) AcceptVisitor(v SchemaErrorVisitor)

+ func (e MaxError) Error() string

+ func (e MaxError) Schema() Schema

+ type MaxLengthError struct

+ ViolatedSchema LengthLimited

+ func (e MaxLengthError) AcceptVisitor(v SchemaErrorVisitor)

+ func (e MaxLengthError) Error() string

+ func (e MaxLengthError) Schema() Schema

+ type MinError struct

+ Numeric Numeric

+ func (e MinError) AcceptVisitor(v SchemaErrorVisitor)

+ func (e MinError) Error() string

+ func (e MinError) Schema() Schema

+ type MinLengthError struct

+ ViolatedSchema LengthLimited

+ func (e MinLengthError) AcceptVisitor(v SchemaErrorVisitor)

+ func (e MinLengthError) Error() string

+ func (e MinLengthError) Schema() Schema

+ type Numeric interface

+ Bits func() int

+ Limits func() (min, max Literal, explicit bool)

+ Max func() (Literal, bool)

+ Min func() (Literal, bool)

+ type OfType struct

+ func Register(registries []*Registry, spec *TypedSpec[T]) *OfType[T]

+ func (v *OfType[T]) Availability() Availability

+ func (v *OfType[T]) Error() Error

+ func (v *OfType[T]) NativeValue() T

+ func (v *OfType[T]) Source() Source

+ func (v *OfType[T]) Spec() Spec

+ func (v *OfType[T]) Value() Value

+ type Other interface

+ type ParagraphFormatter struct

+ Format func(...any) DocumentationBuilder

+ type ProtectedRegistry interface

+ type RefersTo struct

+ RefersTo Spec

+ Subject Spec

+ type RegisteredVariable struct

+ Registry *Registry

+ type Registry struct

+ IsDefault bool

+ Key string

+ Name string

+ URL *url.URL

+ func ExposeRegistry(r ProtectedRegistry) *Registry

+ func (r *Registry) Assign(reg *Registry)

+ func (r *Registry) Clone() *Registry

+ func (r *Registry) Register(v Any)

+ type RegistrySet struct

+ func (s *RegistrySet) Add(r *Registry)

+ func (s *RegistrySet) IsEmpty() bool

+ func (s *RegistrySet) Variables() []RegisteredVariable

+ type Relationship interface

+ type Schema interface

+ AcceptVisitor func(v SchemaVisitor)

+ Finalize func() error

+ Type func() reflect.Type

+ type SchemaError interface

+ AcceptVisitor func(v SchemaErrorVisitor)

+ Schema func() Schema

+ type SchemaErrorVisitor interface

+ VisitMaxError func(MaxError)

+ VisitMaxLengthError func(MaxLengthError)

+ VisitMinError func(MinError)

+ VisitMinLengthError func(MinLengthError)

+ VisitSetMembershipError func(SetMembershipError)

+ type SchemaVisitor interface

+ VisitBinary func(Binary)

+ VisitNumeric func(Numeric)

+ VisitOther func(Other)

+ VisitSet func(Set)

+ VisitString func(String)

+ type Set interface

+ Literals func() []Literal

+ type SetMember struct

+ Description string

+ Value T

+ type SetMembershipError struct

+ Set Set

+ func (e SetMembershipError) AcceptVisitor(v SchemaErrorVisitor)

+ func (e SetMembershipError) Error() string

+ func (e SetMembershipError) Schema() Schema

+ type Source int

+ const SourceDefault

+ const SourceEnvironment

+ const SourceNone

+ type Spec interface

+ Constraints func() []Constraint

+ Default func() (Literal, bool)

+ Description func() string

+ Documentation func() []Documentation

+ Examples func() []Example

+ IsDeprecated func() bool

+ IsRequired func() bool

+ IsSensitive func() bool

+ Name func() string

+ Relationships func() []Relationship

+ Schema func() Schema

+ Zero func() Literal

+ type SpecBuilder interface

+ Description func(string)

+ Documentation func() DocumentationBuilder

+ MarkDeprecated func()

+ MarkRequired func()

+ MarkSensitive func()

+ Name func(string)

+ Peek func() Spec

+ Precondition func(func() bool)

+ type SpecError struct

+ func (e SpecError) Error() string

+ func (e SpecError) Name() string

+ func (e SpecError) Unwrap() error

+ type String interface

+ type Supersedes struct

+ Subject Spec

+ Supersedes Spec

+ type TypedBinary struct

+ EncodingDesc string

+ Marshaler Marshaler[T]

+ MaxLen maybe.Value[int]

+ MinLen maybe.Value[int]

+ func (s TypedBinary[T, B]) AcceptVisitor(v SchemaVisitor)

+ func (s TypedBinary[T, B]) EncodingDescription() string

+ func (s TypedBinary[T, B]) Examples(hasOtherExamples bool) []TypedExample[T]

+ func (s TypedBinary[T, B]) Finalize() error

+ func (s TypedBinary[T, B]) Marshal(v T) (Literal, error)

+ func (s TypedBinary[T, B]) MaxLength() (int, bool)

+ func (s TypedBinary[T, B]) MinLength() (int, bool)

+ func (s TypedBinary[T, B]) Type() reflect.Type

+ func (s TypedBinary[T, B]) Unmarshal(v Literal) (T, error)

+ type TypedConstraint interface

+ Check func(T) ConstraintError

+ type TypedExample struct

+ Description string

+ IsNormative bool

+ Native T

+ type TypedNumeric struct

+ Marshaler Marshaler[T]

+ NativeMax maybe.Value[T]

+ NativeMin maybe.Value[T]

+ func (s TypedNumeric[T]) AcceptVisitor(v SchemaVisitor)

+ func (s TypedNumeric[T]) Bits() int

+ func (s TypedNumeric[T]) Examples(conservative bool) []TypedExample[T]

+ func (s TypedNumeric[T]) Finalize() error

+ func (s TypedNumeric[T]) Limits() (min, max Literal, explicit bool)

+ func (s TypedNumeric[T]) Marshal(v T) (Literal, error)

+ func (s TypedNumeric[T]) Max() (Literal, bool)

+ func (s TypedNumeric[T]) Min() (Literal, bool)

+ func (s TypedNumeric[T]) Type() reflect.Type

+ func (s TypedNumeric[T]) Unmarshal(v Literal) (T, error)

+ type TypedOther struct

+ Marshaler Marshaler[T]

+ func (s TypedOther[T]) AcceptVisitor(v SchemaVisitor)

+ func (s TypedOther[T]) Examples(hasOtherExamples bool) []TypedExample[T]

+ func (s TypedOther[T]) Finalize() error

+ func (s TypedOther[T]) Marshal(v T) (Literal, error)

+ func (s TypedOther[T]) Type() reflect.Type

+ func (s TypedOther[T]) Unmarshal(v Literal) (T, error)

+ type TypedSchema interface

+ Examples func(conservative bool) []TypedExample[T]

+ type TypedSet struct

+ Members []SetMember[T]

+ ToLiteral func(T) Literal

+ func (s TypedSet[T]) AcceptVisitor(v SchemaVisitor)

+ func (s TypedSet[T]) Examples(conservative bool) []TypedExample[T]

+ func (s TypedSet[T]) Finalize() error

+ func (s TypedSet[T]) Literals() []Literal

+ func (s TypedSet[T]) Marshal(v T) (Literal, error)

+ func (s TypedSet[T]) Type() reflect.Type

+ func (s TypedSet[T]) Unmarshal(v Literal) (T, error)

+ type TypedSpec struct

+ func (s *TypedSpec[T]) CheckConstraints(v T) ConstraintError

+ func (s *TypedSpec[T]) Constraints() []Constraint

+ func (s *TypedSpec[T]) Default() (Literal, bool)

+ func (s *TypedSpec[T]) Description() string

+ func (s *TypedSpec[T]) Documentation() []Documentation

+ func (s *TypedSpec[T]) Examples() []Example

+ func (s *TypedSpec[T]) IsDeprecated() bool

+ func (s *TypedSpec[T]) IsRequired() bool

+ func (s *TypedSpec[T]) IsSensitive() bool

+ func (s *TypedSpec[T]) Marshal(v T) (Literal, error)

+ func (s *TypedSpec[T]) Name() string

+ func (s *TypedSpec[T]) Schema() Schema

+ func (s *TypedSpec[T]) Unmarshal(v Literal) (T, Literal, error)

+ func (s *TypedSpec[T]) Zero() Literal

+ func (s TypedSpec[T]) Relationships() []Relationship

+ type TypedSpecBuilder struct

+ func (b *TypedSpecBuilder[T]) BuiltInConstraint(desc string, fn func(T) ConstraintError)

+ func (b *TypedSpecBuilder[T]) Default(v T)

+ func (b *TypedSpecBuilder[T]) Description(desc string)

+ func (b *TypedSpecBuilder[T]) Documentation() DocumentationBuilder

+ func (b *TypedSpecBuilder[T]) Done(schema TypedSchema[T]) *TypedSpec[T]

+ func (b *TypedSpecBuilder[T]) MarkDeprecated()

+ func (b *TypedSpecBuilder[T]) MarkRequired()

+ func (b *TypedSpecBuilder[T]) MarkSensitive()

+ func (b *TypedSpecBuilder[T]) Name(name string)

+ func (b *TypedSpecBuilder[T]) NonNormativeExample(v T, desc string)

+ func (b *TypedSpecBuilder[T]) NormativeExample(v T, desc string)

+ func (b *TypedSpecBuilder[T]) Peek() Spec

+ func (b *TypedSpecBuilder[T]) Precondition(fn func() bool)

+ func (b *TypedSpecBuilder[T]) UserConstraint(desc string, fn func(T) bool)

+ type TypedString struct

+ MaxLen maybe.Value[int]

+ MinLen maybe.Value[int]

+ func (s TypedString[T]) AcceptVisitor(v SchemaVisitor)

+ func (s TypedString[T]) Examples(hasOtherExamples bool) []TypedExample[T]

+ func (s TypedString[T]) Finalize() error

+ func (s TypedString[T]) Marshal(v T) (Literal, error)

+ func (s TypedString[T]) MaxLength() (int, bool)

+ func (s TypedString[T]) MinLength() (int, bool)

+ func (s TypedString[T]) Type() reflect.Type

+ func (s TypedString[T]) Unmarshal(v Literal) (T, error)

+ type Value interface

+ Canonical func() Literal

+ Verbatim func() Literal

+ type ValueError interface

+ AcceptVisitor func(v ValueErrorVisitor)

+ Literal func() Literal

+ Unwrap func() error

+ type ValueErrorVisitor interface

+ VisitGenericError func(error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL