text

package

v0.7.0 Latest Latest Go to latest Published: Aug 9, 2018 License: MIT Imports: 6 Imported by: 0

Details

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

Repository

github.com/be9/prototool

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func SortFailures(failures []*Failure)
type Failure
- func NewFailuref(position scanner.Position, id string, format string, args ...interface{}) *Failure
- func (f *Failure) Fprintln(writer FailureWriter, fields ...FailureField) error
- func (f *Failure) String() string
type FailureField
- func ParseColonSeparatedFailureFields(s string) ([]FailureField, error)
- func ParseFailureField(s string) (FailureField, error)
- func (f FailureField) String() string
type FailureWriter

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// DefaultFailureFields are the default FailureFields.
	DefaultFailureFields = []FailureField{
		FailureFieldFilename,
		FailureFieldLine,
		FailureFieldColumn,
		FailureFieldMessage,
	}
)

Functions ¶

func SortFailures ¶

func SortFailures(failures []*Failure)

SortFailures sorts the Failures, by filename, line, column, id, message.

Types ¶

type Failure ¶

type Failure struct {
	Filename string
	Line     int
	Column   int
	ID       string
	Message  string
}

Failure is a failure with a position in text.

func NewFailuref ¶

func NewFailuref(position scanner.Position, id string, format string, args ...interface{}) *Failure

NewFailuref is a helper that returns a new Failure.

func (*Failure) Fprintln ¶

func (f *Failure) Fprintln(writer FailureWriter, fields ...FailureField) error

Fprintln prints the Failure to the writer with the given ordered fields.

func (*Failure) String ¶

func (f *Failure) String() string

String implements fmt.Stringer.

type FailureField ¶

type FailureField int

FailureField references a field of a Failure.

const (
	// FailureFieldFilename references the Filename field of a Failure.
	FailureFieldFilename FailureField = iota
	// FailureFieldLine references the Line field of a Failure.
	FailureFieldLine
	// FailureFieldColumn references the Column field of a Failure.
	FailureFieldColumn
	// FailureFieldID references the ID field of a Failure.
	FailureFieldID
	// FailureFieldMessage references the Message field of a Failure.
	FailureFieldMessage
)

func ParseColonSeparatedFailureFields ¶

func ParseColonSeparatedFailureFields(s string) ([]FailureField, error)

ParseColonSeparatedFailureFields parses FailureFields from the given string. FailureFields are expected to be colon-separated in the given string. Input is case-insensitive. If the string is empty, DefaultFailureFields will be returned.

func ParseFailureField ¶

func ParseFailureField(s string) (FailureField, error)

ParseFailureField parses the FailureField from the given string.

Input is case-insensitive.

func (FailureField) String ¶

func (f FailureField) String() string

String implements fmt.Stringer.

type FailureWriter ¶

type FailureWriter interface {
	WriteRune(rune) (int, error)
	WriteString(string) (int, error)
}

FailureWriter is a writer that Failure.Println can accept.

Both bytes.Buffer and bufio.Writer implement this.

Source Files ¶

View all Source files

text.go

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