runes

package
Version: v1.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2018 License: Apache-2.0, BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Overview

Package runes provide transforms for UTF-8 encoded text.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Set

type Set interface {
	// Contains returns true if r is contained in the set.
	Contains(r rune) bool
}

A Set is a collection of runes.

func In

func In(rt *unicode.RangeTable) Set

In creates a Set with a Contains method that returns true for all runes in the given RangeTable.

func NotIn

func NotIn(rt *unicode.RangeTable) Set

In creates a Set with a Contains method that returns true for all runes not in the given RangeTable.

func Predicate

func Predicate(f func(rune) bool) Set

Predicate creates a Set with a Contains method that returns f(r).

type Transformer

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

Transformer implements the transform.Transformer interface.

func If

func If(s Set, tIn, tNotIn transform.Transformer) Transformer

If returns a transformer that applies tIn to consecutive runes for which s.Contains(r) and tNotIn to consecutive runes for which !s.Contains(r). Reset is called on tIn and tNotIn at the start of each run. A Nop transformer will substitute a nil value passed to tIn or tNotIn. Invalid UTF-8 is translated to RuneError to determine which transformer to apply, but is passed as is to the respective transformer.

func Map

func Map(mapping func(rune) rune) Transformer

Map returns a Transformer that maps the runes in the input using the given mapping. Illegal bytes in the input are converted to utf8.RuneError before being passed to the mapping func.

func Remove

func Remove(s Set) Transformer

Remove returns a Transformer that removes runes r for which s.Contains(r). Illegal input bytes are replaced by RuneError before being passed to f.

func ReplaceIllFormed

func ReplaceIllFormed() Transformer

ReplaceIllFormed returns a transformer that replaces all input bytes that are not part of a well-formed UTF-8 code sequence with utf8.RuneError.

func (Transformer) Bytes

func (t Transformer) Bytes(b []byte) []byte

Bytes returns a new byte slice with the result of converting b using t. It calls Reset on t. It returns nil if any error was found. This can only happen if an error-producing Transformer is passed to If.

func (Transformer) Reset

func (t Transformer) Reset()

func (Transformer) Span

func (t Transformer) Span(b []byte, atEOF bool) (n int, err error)

func (Transformer) String

func (t Transformer) String(s string) string

String returns a string with the result of converting s using t. It calls Reset on t. It returns the empty string if any error was found. This can only happen if an error-producing Transformer is passed to If.

func (Transformer) Transform

func (t Transformer) Transform(dst, src []byte, atEOF bool) (nDst, nSrc int, err error)

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL