capability

Documentation

Overview

Package capability negotiates optional PawnKit tool adapters.

Index

• Constants
• Variables
• type Document
  • func Probe(ctx context.Context, runner Runner, executable string) (Document, error)
  • func (d Document) Supports(command string) bool
• type OSRunner
  • func (OSRunner) Run(ctx context.Context, name string, args ...string) ([]byte, error)
• type Runner

Constants

const ProtocolVersion = 1

Variables

var (
	ErrUnavailable  = errors.New("capability: tool unavailable")
	ErrIncompatible = errors.New("capability: incompatible protocol")
)

Types

type Document

type Document struct {
	ProtocolVersion int      `json:"protocolVersion"`
	Tool            string   `json:"tool"`
	Version         string   `json:"version"`
	Commands        []string `json:"commands"`
}

func Probe

func Probe(ctx context.Context, runner Runner, executable string) (Document, error)

func (Document) Supports

func (d Document) Supports(command string) bool

type OSRunner

type OSRunner struct{}

func (OSRunner) Run

func (OSRunner) Run(ctx context.Context, name string, args ...string) ([]byte, error)

type Runner

type Runner interface {
	Run(context.Context, string, ...string) ([]byte, error)
}