proto

Documentation

Index

• Constants
• type CommandRequest
• type Request
  • func NewCommandRequest(name string, flags map[string]any) *Request
  • func NewRequest(rType string, data any) *Request
• type Response
  • func NewErrorResult(err *koierr.KoiError) *Response
  • func NewLog(log *rpl.Log) *Response
  • func NewResponse(rType string, data any) *Response
  • func NewResult(code uint16, data any) *Response
  • func NewSuccessResult(data any) *Response
• type Result

Constants

const (
	TypeRequestCommand = "cmd"
)

const (
	TypeResponseLog = "log"
)

const (
	TypeResponseResult = "result"
)

Types

type CommandRequest

type CommandRequest struct {
	// Name is the command name of this [proto.CommandRequest] in kebab-case,
	// like "config" or "dry-run".
	Name string `json:"name" mapstructure:"name"`

	// Flags is a set of flags, which use kebab-case for keys
	// and builtin types for values.
	Flags map[string]any `json:"flags" mapstructure:"flags"`
}

CommandRequest is a request of command. Use kebab-case for command name and flags.

type Request

type Request struct {
	Type string `json:"type" mapstructure:"type"`
	Data any    `json:"data" mapstructure:"data"`
}

func NewCommandRequest

func NewCommandRequest(name string, flags map[string]any) *Request

func NewRequest

func NewRequest(rType string, data any) *Request

type Response

type Response struct {
	Type string `json:"type" mapstructure:"type"`
	Data any    `json:"data" mapstructure:"data"`
}

func NewErrorResult

func NewErrorResult(err *koierr.KoiError) *Response

func NewLog

func NewLog(log *rpl.Log) *Response

func NewResponse

func NewResponse(rType string, data any) *Response

func NewResult

func NewResult(code uint16, data any) *Response

func NewSuccessResult

func NewSuccessResult(data any) *Response

type Result

type Result struct {
	// Code is the status of [proto.Result].
	// 0 represents success and any other code represents an error.
	Code uint16 `json:"code" mapstructure:"code"`

	// Data is the [proto.Result] data.
	Data any `json:"data" mapstructure:"data"`
}