runes

Documentation

Overview

Package runes provides interfaces and utilities for working with runes.

Index

• type Buffer
  • func NewBuffer(data string) Buffer
  • func NewBufferAndLineOffsets(data string) (Buffer, []int32)
  • func NewBufferAndLineOffsetsWithLimit(data string, limit int) (Buffer, []int32, error)
• type SizeLimitError
  • func (e *SizeLimitError) Error() string

Types

type Buffer

type Buffer interface {
	Get(i int) rune
	Slice(i, j int) string
	Len() int
}

Buffer is an interface for accessing a contiguous array of code points.

func NewBuffer

func NewBuffer(data string) Buffer

NewBuffer returns an efficient implementation of Buffer for the given text based on the ranges of the encoded code points contained within.

func NewBufferAndLineOffsets

func NewBufferAndLineOffsets(data string) (Buffer, []int32)

NewBufferAndLineOffsets returns an efficient implementation of Buffer for the given text based on the ranges of the encoded code points contained within, as well as returning the line offsets.

func NewBufferAndLineOffsetsWithLimit

func NewBufferAndLineOffsetsWithLimit(data string, limit int) (Buffer, []int32, error)

NewBufferAndLineOffsetsWithLimit returns an efficient implementation of Buffer for the given text and enforces a code point limit while constructing the buffer.

type SizeLimitError

type SizeLimitError struct {
	Size  int
	Limit int
}

SizeLimitError indicates that the input exceeded the configured code point limit.

func (*SizeLimitError) Error

func (e *SizeLimitError) Error() string