tableprinter

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file expect in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file expect in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file expect in compliance with the License.

Index

• Constants
• type Column
• type TableField
  • func (f *TableField) DisplayWidth() int
• type TableOutputFormat
• type TablePrinter
  • func NewTablePrinter(ctx context.Context, topts ...TablePrinterOption) (*TablePrinter, error)
  • func (printer *TablePrinter) AddField(s string, colorFunc func(string) string)
  • func (printer *TablePrinter) EndRow()
  • func (printer *TablePrinter) Render(w io.Writer) error
• type TablePrinterOption
  • func WithFieldTruncateFunc(truncateFunc func(int, string) string) TablePrinterOption
  • func WithMaxWidth(maxWidth int) TablePrinterOption
  • func WithOutputFormat(format TableOutputFormat) TablePrinterOption
  • func WithOutputFormatFromString(format string) TablePrinterOption
  • func WithTableDelimeter(delim string) TablePrinterOption

Constants

const (
	OutputFormatTable = TableOutputFormat("table")
	OutputFormatJSON  = TableOutputFormat("json")
	OutputFormatYAML  = TableOutputFormat("yaml")

	DefaultDelimeter = "  "
)

Types

type Column

type Column struct {
	Name  string
	Value string
}

Column represents a column name in a table.

type TableField

type TableField struct {
	// contains filtered or unexported fields
}

func (*TableField) DisplayWidth

func (f *TableField) DisplayWidth() int

type TableOutputFormat

type TableOutputFormat string

type TablePrinter

type TablePrinter struct {
	// contains filtered or unexported fields
}

func NewTablePrinter

func NewTablePrinter(ctx context.Context, topts ...TablePrinterOption) (*TablePrinter, error)

NewTablePrinter returns a pointer instance of TablePrinter struct.

func (*TablePrinter) AddField

func (printer *TablePrinter) AddField(s string, colorFunc func(string) string)

AddField adds a new field to the table.

func (*TablePrinter) EndRow

func (printer *TablePrinter) EndRow()

EndRow ends the current row.

func (*TablePrinter) Render

func (printer *TablePrinter) Render(w io.Writer) error

type TablePrinterOption

type TablePrinterOption func(*TablePrinter) error

TablePrinterOption is a type of func(*TablePrinter).

func WithFieldTruncateFunc

func WithFieldTruncateFunc(truncateFunc func(int, string) string) TablePrinterOption

WithFieldTruncateFunc returns a function func(opts *TablePrinter) that sets `truncateFunc` in TablePrinter pointer instance.

func WithMaxWidth

func WithMaxWidth(maxWidth int) TablePrinterOption

WithMaxWidth returns a function func(opts *TablePrinter) that sets `maxWidth` in TablePrinter pointer instance.

func WithOutputFormat

func WithOutputFormat(format TableOutputFormat) TablePrinterOption

WithOutputFormat returns a function func(opts *TablePrinter) that sets `format` in TablePrinter pointer instance.

func WithOutputFormatFromString

func WithOutputFormatFromString(format string) TablePrinterOption

WithOutputFormatFromString returns a function func(opts *TablePrinter) that sets `format` in TablePrinter pointer instance of type `TableOutputFormat` from string.

func WithTableDelimeter

func WithTableDelimeter(delim string) TablePrinterOption

WithTableDelimeter returns a function func(opts *TablePrinter) that sets `delimeter` in TablePrinter pointer instance.