Documentation
¶
Overview ¶
Package rstring provides an efficient way to index strings by rune rather than by byte.
There are three types, Rstring, LRstring, and IRstring, that provide different levels of buffering. For instance, LRstring buffers the rune count, so that it does not have to be recomputed, while Rstring is just a wrapper around string:
R LR IR Buffering - + + RuneCount - - + Position
The IRstring implementation is based on the standard library's exp/utf8string package.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IRstring ¶
type IRstring struct {
// contains filtered or unexported fields
}
String wraps a regular string with a small structure that provides more efficient indexing by code point index, as opposed to byte index. Scanning incrementally forwards or backwards is O(1) per index operation (although not as fast a range clause going forwards). Random access is O(N) in the length of the string, but the overhead is less than always scanning from the beginning. If the string is ASCII, random access is O(1). Unlike the built-in string type, String has internal mutable state and is not thread-safe.
func NewIRstring ¶
NewString returns a new UTF-8 string with the provided contents.
func (*IRstring) At ¶
At returns the rune with index i in the String. The sequence of runes is the same as iterating over the contents with a "for range" clause.
func (*IRstring) ByteIndices ¶
Slice returns the string sliced at rune positions [i:j].
func (*IRstring) Init ¶
Init initializes an existing String to hold the provided contents. It returns a pointer to the initialized String.
Source Files