SDK API reference: `sparkwing/planguard`

SDK API reference: sparkwing/planguard

Package planguard implements the Plan() purity sentinel.

Import as swplanguard "github.com/sparkwing-dev/sparkwing/sparkwing/planguard". The root package and the other subpackages are indexed in sdk-reference.md.

FunctionsSection anchor link

  • func Active(ctx context.Context) bool -- Active reports whether ctx is currently inside a Plan() call.
  • func Guard(ctx context.Context, what string) -- Guard panics if invoked from inside a Pipeline.Plan() call.
  • func With(ctx context.Context) context.Context -- With returns ctx marked as a Plan() invocation context.