tui

Documentation

Index

• Constants
• Variables
• func OutputModeNames() []string
• type BlockMessage
• type DeltaWrap
• type DeltasWrap
• type ErrorWrap
• type ModuleWrap
• type OutputMode
  • func ParseOutputMode(name string) (OutputMode, error)
  • func (x OutputMode) IsValid() bool
  • func (x OutputMode) MarshalText() ([]byte, error)
  • func (x OutputMode) String() string
  • func (x *OutputMode) UnmarshalText(text []byte) error
• type SessionInitMessage
• type SnapshotDeltaWrap
• type TUI
  • func New(req *pbsubstreamsrpc.Request, pkg *pbsubstreams.Package, ...) *TUI
  • func (ui *TUI) Cancel()
  • func (ui *TUI) CleanUpTerminal()
  • func (ui *TUI) Connected()
  • func (ui *TUI) Connecting()
  • func (ui *TUI) IncomingMessage(ctx context.Context, resp *pbsubstreamsrpc.Response, testRunner *test.Runner) error
  • func (ui *TUI) Init(outputMode string) error
  • func (ui *TUI) OnTerminated(f func(error))
  • func (ui *TUI) SetRequest(req *pbsubstreamsrpc.Request)
• type UnknownWrap

Constants

const (
	Connecting msg = iota
	Connected

	Quit
)

Variables

var ErrInvalidOutputMode = fmt.Errorf("not a valid OutputMode, try [%s]", strings.Join(_OutputModeNames, ", "))

Functions

func OutputModeNames

func OutputModeNames() []string

OutputModeNames returns a list of possible string values of OutputMode.

Types

type BlockMessage

type BlockMessage string

type DeltaWrap

type DeltaWrap struct {
	Operation string          `json:"op"`
	Ordinal   uint64          `json:"ordinal"`
	Key       string          `json:"key"`
	OldValue  json.RawMessage `json:"old"`
	NewValue  json.RawMessage `json:"new"`
}

type DeltasWrap

type DeltasWrap struct {
	Module   string      `json:"@module"`
	BlockNum uint64      `json:"@block,omitempty"`
	Deltas   []DeltaWrap `json:"@deltas"`
}

type ErrorWrap

type ErrorWrap struct {
	Module string `json:"@module,omitempty"`
	Error  string `json:"@error"`
	String string `json:"@str"`
	Bytes  []byte `json:"@bytes"`
}

type ModuleWrap

type ModuleWrap struct {
	Module   string          `json:"@module"`
	BlockNum uint64          `json:"@block"`
	Type     string          `json:"@type"`
	Data     json.RawMessage `json:"@data"`
}

type OutputMode

type OutputMode uint

ENUM(TUI, JSON, JSONL, CLOCK, CURSOR)

const (
	// OutputModeTUI is a OutputMode of type TUI.
	OutputModeTUI OutputMode = iota
	// OutputModeJSON is a OutputMode of type JSON.
	OutputModeJSON
	// OutputModeJSONL is a OutputMode of type JSONL.
	OutputModeJSONL
	// OutputModeCLOCK is a OutputMode of type CLOCK.
	OutputModeCLOCK
	// OutputModeCURSOR is a OutputMode of type CURSOR.
	OutputModeCURSOR
)

func ParseOutputMode

func ParseOutputMode(name string) (OutputMode, error)

ParseOutputMode attempts to convert a string to a OutputMode.

func (OutputMode) IsValid

func (x OutputMode) IsValid() bool

IsValid provides a quick way to determine if the typed value is part of the allowed enumerated values

func (OutputMode) MarshalText

func (x OutputMode) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method.

func (OutputMode) String

func (x OutputMode) String() string

String implements the Stringer interface.

func (*OutputMode) UnmarshalText

func (x *OutputMode) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method.

type SessionInitMessage

type SessionInitMessage struct {
	TraceID string
}

type SnapshotDeltaWrap

type SnapshotDeltaWrap struct {
	Module   string    `json:"@module"`
	Progress string    `json:"@progress"`
	Delta    DeltaWrap `json:"@delta"`
}

type TUI

type TUI struct {
	TotalReadBytes uint64
	// contains filtered or unexported fields
}

func New

func New(req *pbsubstreamsrpc.Request, pkg *pbsubstreams.Package, outputStreamNames []string) *TUI

func (*TUI) Cancel

func (ui *TUI) Cancel()

func (*TUI) CleanUpTerminal

func (ui *TUI) CleanUpTerminal()

func (*TUI) Connected

func (ui *TUI) Connected()

func (*TUI) Connecting

func (ui *TUI) Connecting()

func (*TUI) IncomingMessage

func (ui *TUI) IncomingMessage(ctx context.Context, resp *pbsubstreamsrpc.Response, testRunner *test.Runner) error

func (*TUI) Init

func (ui *TUI) Init(outputMode string) error

func (*TUI) OnTerminated

func (ui *TUI) OnTerminated(f func(error))

func (*TUI) SetRequest

func (ui *TUI) SetRequest(req *pbsubstreamsrpc.Request)

type UnknownWrap

type UnknownWrap struct {
	Module      string `json:"@module"`
	UnknownType string `json:"@unknown"`
	String      string `json:"@str"`
	Bytes       []byte `json:"@bytes"`
}