text

Documentation

Index

• type Alignment
• type Format
• type Opt
  • func OptDelim(delim rune) Opt
  • func OptFormat(format Format, fields ...int) Opt
• type Writer
  • func NewWriter(w io.Writer, opts ...Opt) (*Writer, error)
  • func (w *Writer) Write(v []string) error

Types

type Alignment

type Alignment int

Text Alignment

const (
	Left Alignment
	Right
)

type Format

type Format struct {
	// The maximum width of the field
	Width int

	// The alignment of the field (Left or Right)
	Align Alignment

	// Whether to wrap text
	Wrap bool
}

Format defines the format of a field

type Opt

type Opt func(*opts) error

Opt is a function which can be used to set options on the text output

func OptDelim

func OptDelim(delim rune) Opt

Set the field delimiter, default is '|'

func OptFormat

func OptFormat(format Format, fields ...int) Opt

Set the text format for fields. If fields is omitted, then the format is set for all fields

type Writer

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

func NewWriter

func NewWriter(w io.Writer, opts ...Opt) (*Writer, error)

func (*Writer) Write

func (w *Writer) Write(v []string) error