formatter

package

v0.0.2 Latest Latest Go to latest Published: Apr 10, 2017 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/storageos/go-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NamespaceWrite(ctx Context, namespaces []*types.Namespace) error
func PoolWrite(ctx Context, pools []*types.Pool) error
func RuleWrite(ctx Context, rules []*types.Rule) error
func VolumeWrite(ctx Context, volumes []*types.Volume) error
type Context
- func (c *Context) Write(sub subContext, f SubFormat) error
type Format
- func (f Format) Contains(sub string) bool
- func (f Format) IsTable() bool
type HeaderContext
- func (c *HeaderContext) AddHeader(header string)
- func (c *HeaderContext) FullHeader() string
type SubFormat

Constants ¶

View Source

const (
	TableFormatKey  = "table"
	RawFormatKey    = "raw"
	PrettyFormatKey = "pretty"
)

Format keys used to specify certain kinds of output formats

Variables ¶

This section is empty.

Functions ¶

func NamespaceWrite ¶

func NamespaceWrite(ctx Context, namespaces []*types.Namespace) error

NamespaceWrite writes formatted namespaces using the Context

func PoolWrite ¶

func PoolWrite(ctx Context, pools []*types.Pool) error

PoolWrite writes formatted pools using the Context

func RuleWrite ¶

func RuleWrite(ctx Context, rules []*types.Rule) error

RuleWrite writes formatted rules using the Context

func VolumeWrite ¶

func VolumeWrite(ctx Context, volumes []*types.Volume) error

VolumeWrite writes formatted volumes using the Context

Types ¶

type Context ¶

type Context struct {
	// Output is the output stream to which the formatted string is written.
	Output io.Writer
	// Format is used to choose raw, table or custom format for the output.
	Format Format
	// Trunc when set to true will truncate the output of certain fields such as Container ID.
	Trunc bool
	// contains filtered or unexported fields
}

Context contains information required by the formatter to print the output as desired.

func (*Context) Write ¶

func (c *Context) Write(sub subContext, f SubFormat) error

Write the template to the buffer using this Context

type Format ¶

type Format string

Format is the format string rendered using the Context

func NewNamespaceFormat ¶

func NewNamespaceFormat(source string, quiet bool) Format

NewNamespaceFormat returns a format for use with a namespace Context

func NewPoolFormat ¶

func NewPoolFormat(source string, quiet bool) Format

NewPoolFormat returns a format for use with a pool Context

func NewRuleFormat ¶

func NewRuleFormat(source string, quiet bool) Format

NewRuleFormat returns a format for use with a rule Context

func NewVolumeFormat ¶

func NewVolumeFormat(source string, quiet bool) Format

NewVolumeFormat returns a format for use with a volume Context

func (Format) Contains ¶

func (f Format) Contains(sub string) bool

Contains returns true if the format contains the substring

func (Format) IsTable ¶

func (f Format) IsTable() bool

IsTable returns true if the format is a table-type format

type HeaderContext ¶

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

HeaderContext provides the subContext interface for managing headers

func (*HeaderContext) AddHeader ¶

func (c *HeaderContext) AddHeader(header string)

AddHeader adds another column to the header

func (*HeaderContext) FullHeader ¶

func (c *HeaderContext) FullHeader() string

FullHeader returns the header as a string

type SubFormat ¶

type SubFormat func(func(subContext) error) error

SubFormat is a function type accepted by Write()

Source Files ¶

View all Source files

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