annotate

README

annotate

A Go package for applying multiple sets of annotations to a region of text.

Documentation on Nxpkg

Documentation

Index

• Variables
• func Annotate(src []byte, anns Annotations, writeContent func(io.Writer, []byte)) ([]byte, error)
• func IsOutOfBounds(err error) bool
• type Annotation
• type Annotations
  • func (a Annotations) Len() int
  • func (a Annotations) Less(i, j int) bool
  • func (a Annotations) Swap(i, j int)

Variables

var (
	ErrStartOutOfBounds       = errors.New("annotation start out of bounds")
	ErrEndOutOfBounds         = errors.New("annotation end out of bounds")
	ErrStartAndEndOutOfBounds = errors.New("annotations start and end out of bounds")
)

Functions

func Annotate

func Annotate(src []byte, anns Annotations, writeContent func(io.Writer, []byte)) ([]byte, error)

Annotates src with annotations in anns.

Annotating an empty byte array always returns an empty byte array.

Assumes anns is sorted (using sort.Sort(anns)).

func IsOutOfBounds

func IsOutOfBounds(err error) bool

Types

type Annotation

type Annotation struct {
	// Start and End byte offsets (not rune offsets).
	Start, End int

	Left, Right []byte
	WantInner   int
}

type Annotations

type Annotations []*Annotation

func (Annotations) Len

func (a Annotations) Len() int

func (Annotations) Less

func (a Annotations) Less(i, j int) bool

func (Annotations) Swap

func (a Annotations) Swap(i, j int)