message

Documentation

Overview

Package message contains shared messages which are used to communicate between bubbletea components

Index

• func TeaCmd(msg any) func() tea.Msg
• func TerminalSizePollingMsg() tea.Msg
• type HostCreated
• type HostListSelectItem
• type HostSSHConfigLoaded
• type HostUpdated
• type InitComplete
• type RunProcessErrorOccurred
• type RunProcessSSHConnect
• type RunProcessSSHCopyID
• type RunProcessSSHLoadConfig
• type RunProcessSuccess
• type TerminalSizePolling

Functions

func TeaCmd

func TeaCmd(msg any) func() tea.Msg

TeaCmd - is a helper function which creates tea.Cmd from tea.Msg object.

func TerminalSizePollingMsg

func TerminalSizePollingMsg() tea.Msg

TerminalSizePollingMsg - is a tea.Msg which is used to poll terminal size.

Types

type HostCreated

type HostCreated struct{ Host host.Host }

HostCreated - is dispatched when a new host was added to the database.

type HostListSelectItem

type HostListSelectItem struct{ HostID int }

HostListSelectItem is required to let host list know that it's time to update title.

type HostSSHConfigLoaded

type HostSSHConfigLoaded struct {
	HostID int
	Config ssh.Config
}

HostSSHConfigLoaded triggers when app loads a host config using ssh -G <hostname>. The config is stored in main model: m.appState.HostSSHConfig.

type HostUpdated

type HostUpdated struct{ Host host.Host }

HostUpdated - is dispatched when host model is updated.

type InitComplete

type InitComplete struct{}

InitComplete - is a message which is sent when bubbletea models are initialized.

type RunProcessErrorOccurred

type RunProcessErrorOccurred struct {
	ProcessType constant.ProcessType
	StdOut      string // Even if process fails, it may have some output.
	StdErr      string
}

RunProcessErrorOccurred fires when there is an error executing an external process.

type RunProcessSSHConnect

type RunProcessSSHConnect struct{ Host host.Host }

RunProcessSSHConnect is dispatched when user wants to connect to a host.

type RunProcessSSHCopyID

type RunProcessSSHCopyID struct{ Host host.Host }

RunProcessSSHCopyID is dispatched when user wants to copy SSH key to a remote host.

type RunProcessSSHLoadConfig

type RunProcessSSHLoadConfig struct{ Host host.Host }

RunProcessSSHLoadConfig is dispatched it's required to read .ssh/config file for a certain host.

type RunProcessSuccess

type RunProcessSuccess struct {
	ProcessType constant.ProcessType
	StdOut      string
	StdErr      string // Even if process succeeds, it may have some output.
}

RunProcessSuccess fires when external process exits normally.

type TerminalSizePolling

type TerminalSizePolling struct{ Width, Height int }

TerminalSizePolling - is a message which is sent when terminal width and/or height changes.