ruler

type Decoder ¶

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

Decoder parses rulers from input lines

The input is expected to be either

• a ruler template, or
• a row being parsed from an existing PSV table

nil is returned if the input cannot be parsed.

Expected use while parsing a document:

rulerDec := NewDecoder()
rowDec   := NewRowDecoder()

for scanner.Scan() {
    line := scanner.Text()
    prefix, content := SplitPrefix(line)
    doc.SetTablePrefixOnce(prefix)
    if ruler := rulerDec.Decode(content); ruler != nil {
        doc.AppendRuler(ruler)
        continue
    }
    if row := rowDec.Decode(content); row != nil {
        doc.AppendRow(row)
        continue
    }
    // line is not part of the table
}

A Ruler may also be created via &model.Ruler{}, in which case it will use the default template of "| -"

func NewDecoder() *Decoder

func (d *Decoder) Decode(input string) (*model.Ruler, []model.ColumnFlags)

type Encoder ¶

type Encoder struct {
	*HintStyle
}

func (enc *Encoder) Encode(
	buf *bytes.Buffer,
	ruler *model.Ruler,
	cws []model.ColumnWidth,
)

func (enc *Encoder) EncodeWithHints(
	buf *bytes.Buffer,
	ruler *model.Ruler,
	cws []model.ColumnWidth,
	cfs []model.ColumnFlags,
)

[padding] <left> <line> <center> <line> <right> <order> [<padding>]

func (enc *Encoder) MinWidth(cf model.ColumnFlags) int

type HintStyle ¶

type HintStyle struct {
	FlagsMask   model.ColumnFlags                       // mask to remove unsupported flags, 0: everything supported, 0xff: nothing supported
	AlignLeft   string                                  //
	AlignRight  string                                  //
	AlignCenter string                                  //
	AlignNumber string                                  //
	Replace     map[model.ColumnFlags]model.ColumnFlags // map of equivalent flags
}

REFACTOR: 2025-03-12 move to EncodingStyle see also cmd/psv/flags.go

type RulerBuilder ¶

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

func (rb *RulerBuilder) SetAlignment(alignmentFlags model.ColumnFlags)

func (rb *RulerBuilder) SetSort(sortFlags model.ColumnFlags)

func (rb *RulerBuilder) SetSortPriority(sortPriority int)