rulecontext

package

v0.2.1 Latest Latest Go to latest Published: Oct 25, 2023 License: BSD-3-Clause Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package rulecontext implements some helper functions to store values from the standard Go Context package.

This section is empty.

View Source

var RuleSetContextKey int

func Printer(ctx context.Context) *message.Printer

Printer returns the most recent printer from the context. If none is found it returns the default printer.

This function never returns nil.

func RuleSet(ctx context.Context) any

RuleSet returns the most resent rule set.

For nested objects there may be more than one but only the most recent can be retrieved.

func WithPathIndex(parent context.Context, value int) context.Context

WithPathIndex returns a new Context with the path segment index added.

func WithPathString(parent context.Context, value string) context.Context

WithPathString returns a new Context with the path segment added.

func WithPrinter(parent context.Context, printer *message.Printer) context.Context

WithPrinters adds a printer key to a context

func WithRuleSet(parent context.Context, ruleSet any) context.Context

WithRuleSet adds a rule set to the context.

type PathSegment interface {
	Parent() PathSegment
	String() string
	FullString() string
}

func Path(ctx context.Context) PathSegment

Path returns the most recently added path segment, which can then be used to build out the full path.