tools

Documentation

Index

• Constants
• Variables
• func CanConsumePublicImages(conf cfg.Configuration) bool
• func HostPlatform(ctx context.Context, conf cfg.Configuration) (specs.Platform, error)
• func InvokeFunction(ctx context.Context, loc pkggraph.Location, rootDir string, ...) (compute.Computable[*protocol.InvokeResponse], error)
• func InvokeWithBinary(ctx context.Context, env pkggraph.SealedContext, inv *types.DeferredInvocation, ...) (compute.Computable[*protocol.InvokeResponse], error)
• func Run(ctx context.Context, conf cfg.Configuration, opts rtypes.RunToolOpts) error
• func RunWithOpts(ctx context.Context, conf cfg.Configuration, opts rtypes.RunToolOpts, ...) error
• type LowLevelInvokeOptions
  • func (oo LowLevelInvokeOptions[Req, Resp]) Invoke(ctx context.Context, conf cfg.Configuration, pkg schema.PackageName, ...) (Resp, error)
  • func (oo LowLevelInvokeOptions[Req, Resp]) InvokeOnBuildkit(ctx context.Context, conf cfg.Configuration, method string, ...) (Resp, error)
• type ResolveMethodFunc
• type Runtime

Constants

const (
	MaxInvocationDuration = 1 * time.Minute
)

Variables

var InvocationCanUseBuildkit = false

var LowLevelToolsProtocolVersion = 2

var MakeAlternativeRuntime func(cfg.Configuration) Runtime

Functions

func CanConsumePublicImages

func CanConsumePublicImages(conf cfg.Configuration) bool

func HostPlatform

func HostPlatform(ctx context.Context, conf cfg.Configuration) (specs.Platform, error)

func InvokeFunction

func InvokeFunction(ctx context.Context, loc pkggraph.Location, rootDir string, inv *types.DeferredInvocation) (compute.Computable[*protocol.InvokeResponse], error)

func InvokeWithBinary

func InvokeWithBinary(ctx context.Context, env pkggraph.SealedContext, inv *types.DeferredInvocation, prepared *binary.Prepared) (compute.Computable[*protocol.InvokeResponse], error)

func Run

func Run(ctx context.Context, conf cfg.Configuration, opts rtypes.RunToolOpts) error

func RunWithOpts

func RunWithOpts(ctx context.Context, conf cfg.Configuration, opts rtypes.RunToolOpts, onStart func()) error

Types

type LowLevelInvokeOptions

type LowLevelInvokeOptions[Req, Resp proto.Message] struct {
	RedactRequest  func(proto.Message) proto.Message
	RedactResponse func(proto.Message) proto.Message
}

func (LowLevelInvokeOptions[Req, Resp]) Invoke

func (oo LowLevelInvokeOptions[Req, Resp]) Invoke(ctx context.Context, conf cfg.Configuration, pkg schema.PackageName, opts rtypes.RunToolOpts, req Req, resolve ResolveMethodFunc[Req, Resp]) (Resp, error)

func (LowLevelInvokeOptions[Req, Resp]) InvokeOnBuildkit

func (oo LowLevelInvokeOptions[Req, Resp]) InvokeOnBuildkit(ctx context.Context, conf cfg.Configuration, method string, pkg schema.PackageName, imageID oci.ImageID, opts rtypes.RunToolOpts, req Req) (Resp, error)

type ResolveMethodFunc

type ResolveMethodFunc[Req, Resp proto.Message] func(*grpc.ClientConn) func(context.Context, Req, ...grpc.CallOption) (Resp, error)

type Runtime

type Runtime interface {
	RunWithOpts(context.Context, rtypes.RunToolOpts, func()) error
	HostPlatform(context.Context) (specs.Platform, error)
	CanConsumePublicImages() bool // Whether this runtime implementation can use an ImageID directly if one is available.
}