format

package

v0.9.15 Latest Latest Go to latest Published: Apr 27, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/xeol-io/xeol

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func GetPresenter(format Format, pb models.PresenterConfig) presenter.Presenter
func Tprintf(tmpl string, data map[string]interface{}) string
type Format
- func Parse(userInput string) Format
- func (f Format) String() string
type ScanResultWriter
- func MakeScanResultWriter(outputs []string, defaultFile string) (ScanResultWriter, error)
- func MakeScanResultWriterForFormat(f string, path string) (ScanResultWriter, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var AvailableFormats = []Format{
	JSONFormat,
	TableFormat,
}

AvailableFormats is a list of presenter format options available to users.

Functions ¶

func GetPresenter ¶ added in v0.9.0

func GetPresenter(format Format, pb models.PresenterConfig) presenter.Presenter

GetPresenter retrieves a Presenter that matches a CLI option

func Tprintf ¶

func Tprintf(tmpl string, data map[string]interface{}) string

Tprintf renders a string from a given template string and field values

Types ¶

type Format ¶ added in v0.9.0

type Format string

Format is a dedicated type to represent a specific kind of presenter output format.

const (
	UnknownFormat Format = "unknown"
	JSONFormat    Format = "json"
	TableFormat   Format = "table"
)

func Parse ¶ added in v0.9.0

func Parse(userInput string) Format

Parse returns the presenter.format specified by the given user input.

func (Format) String ¶ added in v0.9.0

func (f Format) String() string

type ScanResultWriter ¶ added in v0.9.0

type ScanResultWriter interface {
	Write(result models.PresenterConfig) error
}

func MakeScanResultWriter ¶ added in v0.9.0

func MakeScanResultWriter(outputs []string, defaultFile string) (ScanResultWriter, error)

MakeScanResultWriter creates a ScanResultWriter for output or returns an error. this will either return a valid writer or an error but neither both and if there is no error, ScanResultWriter.Close() should be called

func MakeScanResultWriterForFormat ¶ added in v0.9.0

func MakeScanResultWriterForFormat(f string, path string) (ScanResultWriter, error)

MakeScanResultWriterForFormat creates a ScanResultWriter for the given format or returns an error.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL