annotate

package module

v0.0.0-...-f4cad6c Latest Latest Go to latest Published: Jan 23, 2016 License: BSD-3-Clause Imports: 3 Imported by: 35

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sourcegraph/annotate

Links

Open Source Insights

README ¶

annotate

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

Documentation on Sourcegraph

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

Constants ¶

This section is empty.

Variables ¶

View Source

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)

Source Files ¶

View all Source files

annotate.go

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