pluginrpc

package module

Go to main page

Versions in this module

v0

v0.5.0

Sep 28, 2024

Changes in this version

type ServerOption

+ func ServerWithDoc(doc string) ServerOption

v0.4.0

Sep 28, 2024

Changes in this version

+ const IsAtLeastVersion0_4_0

type Spec

+ func MergeSpecs(specs ...Spec) (Spec, error)

v0.3.0

Sep 5, 2024

v0.2.0

Aug 30, 2024

Changes in this version

+ const FormatFlagName

+ const ProtocolFlagName

+ const SpecFlagName

v0.1.0

Aug 28, 2024

Changes in this version

+ const IsAtLeastVersion0_1_0

+ const Version

+ var AllFormats = []Format

+ var OSEnv = Env

+ func Main(newServer func() (Server, error), _ ...MainOption)

+ func NewProtoProcedure(procedure Procedure) *pluginrpcv1.Procedure

+ func NewProtoSpec(spec Spec) *pluginrpcv1.Spec

+ type CallOption func(*callOptions)

+ type Client interface

+ Call func(ctx context.Context, procedurePath string, request any, response any, ...) error

+ Spec func(ctx context.Context) (Spec, error)

+ func NewClient(runner Runner, options ...ClientOption) Client

+ type ClientOption func(*clientOptions)

+ func ClientWithFormat(format Format) ClientOption

+ func ClientWithStderr(stderr io.Writer) ClientOption

+ type Code uint32

+ const CodeAborted

+ const CodeAlreadyExists

+ const CodeCanceled

+ const CodeDataLoss

+ const CodeDeadlineExceeded

+ const CodeFailedPrecondition

+ const CodeInternal

+ const CodeInvalidArgument

+ const CodeNotFound

+ const CodeOutOfRange

+ const CodePermissionDenied

+ const CodeResourceExhausted

+ const CodeUnauthenticated

+ const CodeUnavailable

+ const CodeUnimplemented

+ const CodeUnknown

+ func CodeForProto(protoCode pluginrpcv1.Code) (Code, error)

+ func (c Code) String() string

+ func (c Code) ToProto() (pluginrpcv1.Code, error)

+ type Env struct

+ Args []string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ type Error struct

+ func NewError(code Code, underlying error) *Error

+ func NewErrorForProto(protoError *pluginrpcv1.Error) *Error

+ func NewErrorf(code Code, format string, args ...any) *Error

+ func WrapError(err error) *Error

+ func (e *Error) Code() Code

+ func (e *Error) Error() string

+ func (e *Error) ToProto() *pluginrpcv1.Error

+ func (e *Error) Unwrap() error

+ type ExecRunnerOption func(*execRunnerOptions)

+ func ExecRunnerWithArgs(args ...string) ExecRunnerOption

+ type ExitError struct

+ func NewExitError(exitCode int, underlying error) *ExitError

+ func WrapExitError(err error) *ExitError

+ func (e *ExitError) Error() string

+ func (e *ExitError) ExitCode() int

+ func (e *ExitError) Unwrap() error

+ type Format uint32

+ const FormatBinary

+ const FormatJSON

+ func FormatForString(s string) Format

+ func (f Format) String() string

+ type HandleEnv struct

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ type HandleOption func(*handleOptions)

+ func HandleWithFormat(format Format) HandleOption

+ type Handler interface

+ Handle func(ctx context.Context, handleEnv HandleEnv, request any, ...) error

+ func NewHandler(spec Spec, _ ...HandlerOption) Handler

+ type HandlerOption func(*handlerOptions)

+ type MainOption func(*mainOptions)

+ type Procedure interface

+ Args func() []string

+ Path func() string

+ func NewProcedure(path string, options ...ProcedureOption) (Procedure, error)

+ func NewProcedureForProto(protoProcedure *pluginrpcv1.Procedure) (Procedure, error)

+ type ProcedureOption func(*procedureOptions)

+ func ProcedureWithArgs(args ...string) ProcedureOption

+ type Runner interface

+ Run func(ctx context.Context, env Env) error

+ func NewExecRunner(programName string, options ...ExecRunnerOption) Runner

+ func NewServerRunner(server Server, _ ...ServerRunnerOption) Runner

+ type Server interface

+ Serve func(ctx context.Context, env Env) error

+ func NewServer(spec Spec, serverRegistrar ServerRegistrar, _ ...ServerOption) (Server, error)

+ type ServerOption func(*serverOptions)

+ type ServerRegistrar interface

+ Register func(path string, ...)

+ func NewServerRegistrar() ServerRegistrar

+ type ServerRunnerOption func(*serverRunnerOptions)

+ type Spec interface

+ ProcedureForPath func(path string) Procedure

+ Procedures func() []Procedure

+ func NewSpec(procedures []Procedure) (Spec, error)

+ func NewSpecForProto(protoSpec *pluginrpcv1.Spec) (Spec, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL