Documentation
¶
Index ¶
- func Cf(cmdStarter Starter, args ...string) *gexec.Session
- func CfWithCustomReporter(cmdStarter Starter, reporter Reporter, args ...string) *gexec.Session
- func RegisterObserver(observer CommandObserver)
- func UnregisterObserver()
- type CommandObserver
- type CompletionReporter
- type ObservingReporter
- type RedactingReporter
- type Redactor
- type Reporter
- type Starter
- type TeeReporter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfWithCustomReporter ¶
func RegisterObserver ¶ added in v2.15.0
func RegisterObserver(observer CommandObserver)
func UnregisterObserver ¶ added in v2.15.0
func UnregisterObserver()
Types ¶
type CommandObserver ¶ added in v2.15.0
type CommandObserver interface {
CommandStarted(redactedArgs string, startTime time.Time)
CommandCompleted(redactedArgs string, elapsed time.Duration, exitCode int)
}
CommandObserver receives a redacted joined-args identity, never raw args.
func RegisteredObserver ¶ added in v2.15.0
func RegisteredObserver() CommandObserver
type CompletionReporter ¶ added in v2.15.0
type ObservingReporter ¶ added in v2.15.0
type ObservingReporter struct {
// contains filtered or unexported fields
}
ObservingReporter is the only type that touches the observer; it redacts the args before forwarding, keeping redaction inside the reporter.
func NewObservingReporter ¶ added in v2.15.0
func NewObservingReporter(observer CommandObserver, redactor Redactor) *ObservingReporter
func (*ObservingReporter) Report ¶ added in v2.15.0
func (r *ObservingReporter) Report(startTime time.Time, cmd *exec.Cmd)
func (*ObservingReporter) ReportCompletion ¶ added in v2.15.0
type RedactingReporter ¶
type RedactingReporter struct {
// contains filtered or unexported fields
}
func NewRedactingReporter ¶
func NewRedactingReporter(writer io.Writer, redactor Redactor) *RedactingReporter
func (*RedactingReporter) Redactor ¶ added in v2.15.0
func (r *RedactingReporter) Redactor() Redactor
type Redactor ¶
func NewRedactor ¶
type Reporter ¶
func ObservedReporter ¶ added in v2.15.0
type TeeReporter ¶ added in v2.15.0
type TeeReporter struct {
// contains filtered or unexported fields
}
TeeReporter fans Report to every reporter; ReportCompletion reaches only those that also implement CompletionReporter.
func NewTeeReporter ¶ added in v2.15.0
func NewTeeReporter(reporters ...Reporter) *TeeReporter
func (*TeeReporter) Report ¶ added in v2.15.0
func (t *TeeReporter) Report(startTime time.Time, cmd *exec.Cmd)
func (*TeeReporter) ReportCompletion ¶ added in v2.15.0
Source Files
¶
Click to show internal directories.
Click to hide internal directories.