explain

Documentation

Overview

Package explain contains explainers that are used for processing an incoming stream, and explaining the events that are found in it.

Index

• type AnsibleEventExplainer
  • func DefaultExplainer(verbose bool, out io.Writer) AnsibleEventExplainer
  • func PreflightExplainer(verbose bool, out io.Writer) AnsibleEventExplainer
• type AnsibleEventStreamExplainer
  • func (e *AnsibleEventStreamExplainer) Explain(events <-chan ansible.Event) error

Types

type AnsibleEventExplainer

type AnsibleEventExplainer interface {
	ExplainEvent(e ansible.Event)
}

AnsibleEventExplainer explains a single event

func DefaultExplainer

func DefaultExplainer(verbose bool, out io.Writer) AnsibleEventExplainer

DefaultExplainer returns the default ansible explainer

func PreflightExplainer

func PreflightExplainer(verbose bool, out io.Writer) AnsibleEventExplainer

PreflightExplainer is an explainer to be used when running preflight checks.

type AnsibleEventStreamExplainer

type AnsibleEventStreamExplainer struct {
	// EventExplainer for processing ansible events
	EventExplainer AnsibleEventExplainer
}

AnsibleEventStreamExplainer explains the incoming ansible event stream

func (*AnsibleEventStreamExplainer) Explain

func (e *AnsibleEventStreamExplainer) Explain(events <-chan ansible.Event) error

Explain the incoming ansible event stream