fabctx

Documentation

Index

• func GetEvalContext(ctx context.Context) *hcl.EvalContext
• func NoSignals(opts *fabCtxOpts)
• func WithEvalContext(ctx context.Context, evalCtxKey *hcl.EvalContext) context.Context
• type FabCtx
  • func Get(ctx context.Context) *FabCtx
  • func New(options ...Option) *FabCtx
  • func (ctx *FabCtx) CleanupCtx() context.Context
  • func (ctx *FabCtx) Deadline() (deadline time.Time, ok bool)
  • func (ctx *FabCtx) Done() <-chan struct{}
  • func (ctx *FabCtx) Err() error
  • func (ctx *FabCtx) Value(v any) any
• type Option

Functions

func GetEvalContext

func GetEvalContext(ctx context.Context) *hcl.EvalContext

func NoSignals

func NoSignals(opts *fabCtxOpts)

func WithEvalContext

func WithEvalContext(ctx context.Context, evalCtxKey *hcl.EvalContext) context.Context

Types

type FabCtx

type FabCtx struct {
	// contains filtered or unexported fields
}

FabCtx is a context that can be used to cancel the main context and trigger cleanup. It is used to handle graceful shutdowns for the fabric CLI.

func Get

func Get(ctx context.Context) *FabCtx

func New

func New(options ...Option) *FabCtx

Returns a cli-appropriate context (cancelable by ctrl+c).

func (*FabCtx) CleanupCtx

func (ctx *FabCtx) CleanupCtx() context.Context

func (*FabCtx) Deadline

func (ctx *FabCtx) Deadline() (deadline time.Time, ok bool)

func (*FabCtx) Done

func (ctx *FabCtx) Done() <-chan struct{}

func (*FabCtx) Err

func (ctx *FabCtx) Err() error

func (*FabCtx) Value

func (ctx *FabCtx) Value(v any) any

type Option

type Option func(*fabCtxOpts)