command.go RawHistoryFolder

1package protocol
2
3// CommandRequest asks the daemon to run one control command. Version must stay
4// first so a future payload layout can still be rejected cleanly.
5type CommandRequest struct {
6	Version       uint16
7	RequestID     uint64
8	Attached      bool
9	Self          bool
10	Slug          string
11	Args          []string
12	TargetSession string
13	TargetTab     string
14	TargetPane    string
15	JSON          bool
16}
17
18// CommandOutcome is the closed terminal state of a dispatched command.
19type CommandOutcome uint8
20
21const (
22	CommandSucceeded CommandOutcome = iota + 1
23	CommandFailed
24	CommandOutcomeUnknown
25)
26
27// CommandResult reports a control command's explicit terminal outcome.
28type CommandResult struct {
29	RequestID uint64
30	Outcome   CommandOutcome
31	Code      uint16
32	Text      string
33	Output    string
34}
35
36// Valid reports whether the result obeys the closed outcome contract.
37func (r CommandResult) Valid() bool {
38	switch r.Outcome {
39	case CommandSucceeded:
40		return r.Code == 0 && r.Text == ""
41	case CommandFailed:
42		return r.Code != 0 && r.Output == ""
43	case CommandOutcomeUnknown:
44		return r.Code == 0 && r.Output == ""
45	default:
46		return false
47	}
48}