modules

Documentation

Index

• Variables
• type BackMsg
• type Canceler
• type Default
• type ErrMsg
• type Error
  • func (e Error) Error() string
  • func (e Error) Render(width int) string
• type ForkBackMsg
• type ForkMsg
• type Forker
• type InitMsg
• type Module
• type ModulePiper
• type NextMsg
• type PipeCancelFuncMsg
• type PipeDoneMsg
• type PipeMessenger
• type PipeMsg
• type Piper
• type ResizeMsg

Variables

var Back = func() tea.Msg { return BackMsg{} }

Back loads the previous module in the pipeline.

var Init = func() tea.Msg { return InitMsg{} }

Init initialized the first module of the pipeline.

var Next = func() tea.Msg { return NextMsg{} }

Next loads the next module in the pipeline.

var None = func() tea.Msg { return nil }

None is a placeholder to be returned from the module's init function. If the modules doesn't need to do anything special, it must return None instead of nil.

var Resize = func() tea.Msg { return ResizeMsg{} }

Resize can be used, to manually trigger a resize of the tui components.

Types

type BackMsg

type BackMsg struct{}

type Canceler

type Canceler interface {
	CancelFunc() ctx.CancelFunc
}

type Default

type Default struct {
	ForkBackMsg ForkBackMsg
	Ctx         *context.Context
	PrePipe     []Piper
	Pipe        []Piper
	PostPipe    []Piper
}

type ErrMsg

type ErrMsg error

type Error

type Error struct {
	Message string
	Help    string
}

func (Error) Error

func (e Error) Error() string

func (Error) Render

func (e Error) Render(width int) string

type ForkBackMsg

type ForkBackMsg int

type ForkMsg

type ForkMsg int

const (
	ForkMsgNone ForkMsg = iota
	ForkMsgQuit
	ForkMsgTrade
	ForkMsgSwap
	ForkMsgOrder
	ForkMsgSettings
	ForkMsgWalletSettings
	ForkMsgWalletSettingsNew
	ForkMsgWalletSettingsDerivation
	ForkMsgCustomEndpoint
)

type Forker

type Forker interface {
	Fork() ForkMsg
}

type InitMsg

type InitMsg struct{}

type Module

type Module interface {
	fmt.Stringer

	Init(ctx *context.Context) tea.Cmd
	Update(tea.Msg) tea.Cmd
	Cancel()
}

type ModulePiper

type ModulePiper interface {
	PrePipe() []Piper
	Pipe() []Piper
	PostPipe() []Piper
}

type NextMsg

type NextMsg struct{}

type PipeCancelFuncMsg

type PipeCancelFuncMsg ctx.CancelFunc

type PipeDoneMsg

type PipeDoneMsg struct{}

type PipeMessenger

type PipeMessenger interface {
	Message() string
}

type PipeMsg

type PipeMsg string

type Piper

type Piper interface {
	fmt.Stringer

	Run(ctx *context.Context) error
}

type ResizeMsg

type ResizeMsg struct{}