apptypes

type BackupsFocus ¶ added in v0.7.0

type BackupsFocus int

BackupsFocus names which half of the Backups page the arrows are driving.

It lives here rather than in either panel because four packages have to agree on it: AppModel owns the value and tab moves it, cmds carries it to the panels, keys reads it to decide whether the footer says "navigate" or "scroll", and the two panels route their own keys by it.

The Backups page is the only page with focus. Home and Services gave theirs up because their two panels are two views of one selection (see docs/DESIGN.md); here the panels are a cursor over metadata and a scrolling file, which are genuinely two things to drive.

const (
	// BackupsList is the zero value because the page opens on the list: it is
	// the panel with the cursor, and the preview has nothing in it until the
	// cursor picks a row.
	BackupsList BackupsFocus = iota
	BackupsPreview
)

func (f BackupsFocus) Toggled() BackupsFocus

type CheckableServiceItem ¶

type CheckableServiceItem struct {
	Name    string
	Checked bool
}

CheckableServiceItem is a list.Item for the service-selection checklist shown when creating a group.

func (s CheckableServiceItem) FilterValue() string

func (s CheckableServiceItem) Title() string

type ComposeFileItem ¶

type ComposeFileItem struct {
	Name   string
	Active bool
}

ComposeFileItem is a list.Item for the file picker on the Files page. Active marks the file currently loaded, so the picker can say which one the user is already looking at.

func (s ComposeFileItem) FilterValue() string

func (s ComposeFileItem) Title() string

type DockerContainer ¶

type DockerContainer struct {
	Command   string
	CreatedAt string
	// docker compose ps names this field "Health". Without the tag, the
	// field never binds and the HEALTH column reads "-" for every
	// container, healthy ones included.
	HealthStatus string `json:"Health"`
	ID           string
	Image        string
	Labels       string
	LocalVolumes string
	Mounts       string
	Names        string
	Networks     string
	Platforms    struct {
		// contains filtered or unexported fields
	}
	Ports      string
	RunningFor string
	Service    string
	Size       string
	State      string
	Status     string

	// Runtime stats from `docker stats --no-stream`. These are populated
	// by GetContainerStats, not by docker compose ps.
	MemPerc  string // e.g. "0.07%"
	MemUsage string // e.g. "21.71MiB / 31.02GiB"
	NetIO    string // e.g. "3.22MB / 4.7kB"
	BlockIO  string // e.g. "70.3MB / 43.7MB"
	CPUPerc  string // e.g. "0.00%"
	PIDs     string // e.g. "19"
}

func ContainerForService(containers []DockerContainer, serviceName string) (DockerContainer, bool)

type GroupListItem ¶

type GroupListItem struct {
	Name    string
	Running int
	Total   int
}

GroupListItem is one row in the groups list. It carries the group's name plus how many of its member services are running, so the row can render a status dot (green when fully running, amber half-circle when mixed).

func (s GroupListItem) FilterValue() string

func (s GroupListItem) Title() string

type ListItem ¶

type ListItem struct {
	ItemTitle, ItemDesc string
}

func (i ListItem) Description() string

func (i ListItem) FilterValue() string

func (i ListItem) Title() string

type Page ¶ added in v0.7.0

type Page string

Page is a page's identity - the value every screen-scoped switch matches on.

It is a defined type rather than a bare string because five packages switch on it (AppModel routes keys and panels by it, cmds carries it, keys picks the footer's bindings from it, keybindingbar mirrors it, mainmenu renders the tabs from it) and every one of those switches falls through silently on a value it does not know. As a string that made a typo a page that quietly does nothing; as a type it is a compile error, and the constants below are the only spellings that exist.

The underlying string is still the page's ID and is still what the display label falls back to, so an unlisted page renders as its own name rather than as blank.

const (
	PageHome         Page = "Home"
	PageServices     Page = "Services"
	PageComposeFiles Page = "Compose Files"
	PageBackups      Page = "Backups"
)

func PageForShortcut(letter string) Page

type ServiceListItem ¶

type ServiceListItem struct {
	Service types.ServiceConfig
	// Status is docker's own container state for this service - running,
	// restarting, paused, created, removing, exited or dead - or "stopped"
	// when the service has no container, or "" for unknown (docker has not
	// answered yet). Set by ServicesListModel when a GetRunningContainersMsg
	// arrives, and read through apptypes.ClassifyContainerState rather than
	// compared directly.
	Status string
	// MemUsage is the real-time memory usage from docker stats, exactly as
	// docker reports it: "21.71MiB / 31.02GiB". Empty when stats are
	// unavailable. Store it raw - FormatMemUsage is applied once, at render
	// time, and formatting it on the way in instead would double-apply the
	// percent suffix.
	MemUsage string
	// MemPerc is the memory usage percentage from docker stats, e.g. "0.07%"
	MemPerc string
}

func (s ServiceListItem) Description(isActive bool) string

func (s ServiceListItem) FilterValue() string

func (s ServiceListItem) Title() string

type StateTier ¶ added in v0.7.0

type StateTier int

StateTier is what the UI actually distinguishes about a container's state.

Docker reports seven states - created, restarting, running, removing, paused, exited and dead - and the app used to fold all of them into "running" or "stopped". That was survivable while the only question was "is it up", but it meant a container docker had given up on (dead) and one the user had deliberately stopped (exited) rendered identically, and a service mid-restart looked stopped rather than busy.

The tiers exist so the colour choice is made once. What a tier *means* is the point; which colour draws it is chrome's business.

const (
	// TierUnknown is "docker has not answered yet", not a state docker
	// reports. Rendering it as stopped is a guess dressed up as a fact -
	// see serviceslist.Model.containersKnown.
	TierUnknown StateTier = iota

	// TierRunning is the one state that means the service is up.
	TierRunning

	// TierTransitional is on its way somewhere under its own power:
	// restarting will likely be running shortly, paused is deliberately
	// frozen. Both want attention without claiming a fault.
	TierTransitional

	// TierInert exists but is not doing anything, and nobody needs to act:
	// created has never been started, removing is on its way out because
	// somebody asked for it.
	TierInert

	// TierStopped is the ordinary, expected stop - exited, or no container
	// at all. It is by far the most common non-running state, which is why
	// it does not get the fault colour.
	TierStopped

	// TierFault is dead: docker could not remove the container and cannot
	// act on it. This is the only tier that means something is wrong.
	TierFault
)

func ClassifyContainerState(state string) StateTier

type ThemeItem ¶

type ThemeItem struct {
	Name   string
	Active bool
}

ThemeItem is a list.Item for the theme picker modal. Active marks the theme that was in effect when the modal opened, so the user can see which one they started from and Esc can restore it.

func (t ThemeItem) FilterValue() string

func (t ThemeItem) Title() string