...

Package printer

import "sigs.k8s.io/cli-utils/cmd/status/printers/printer"
Overview
Index

Overview ▾

Index ▾

Package files

printer.go

type PrintData

PrintData records data required for printing

type PrintData struct {
    Identifiers object.ObjMetadataSet
    InvNameMap  map[object.ObjMetadata]string
    StatusSet   map[string]bool
}

type Printer

Printer defines an interface for outputting information about status of resources. Different implementations allow output formats tailored to different use cases.

type Printer interface {

    // Print tells the printer to start outputting data. The stop parameter
    // is a channel that the caller will use to signal to the printer that it
    // needs to stop and shut down. The channel returned can be used by the
    // printer implementation to signal that it has outputted all the data it
    // needs to, and that it has completed shutting down. The latter is important
    // to make sure the printer has a chance to output all data before the
    // program terminates.
    Print(ch <-chan event.Event, identifiers object.ObjMetadataSet, cancelFunc collector.ObserverFunc) error
}