presenter

Documentation

Overview

Defines a Presenter interface for displaying catalog results to an io.Writer as well as a helper utility to obtain a specific Presenter implementation given user configuration.

Index

• Variables
• type Option
  • func ParseOption(userStr string) Option
• type Presenter
  • func GetPresenter(option Option, srcMetadata source.Metadata, catalog *pkg.Catalog, ...) Presenter

Variables

var Options = []Option{
	JSONPresenter,
	TextPresenter,
	TablePresenter,
	CycloneDxPresenter,
}

Types

type Option

type Option string

const (
	UnknownPresenter   Option = "UnknownPresenter"
	JSONPresenter      Option = "json"
	TextPresenter      Option = "text"
	TablePresenter     Option = "table"
	CycloneDxPresenter Option = "cyclonedx"
)

func ParseOption

func ParseOption(userStr string) Option

type Presenter

type Presenter interface {
	Present(io.Writer) error
}

Presenter defines the expected behavior for an object responsible for displaying arbitrary input and processed data to a given io.Writer.

func GetPresenter

func GetPresenter(option Option, srcMetadata source.Metadata, catalog *pkg.Catalog, d *distro.Distro) Presenter

GetPresenter returns a presenter for images or directories