README
¶
rope
Implementation of the rope data structure in Go. This library can be used by a text editor to improve performance as the user is making ad-hoc changes at arbirary locations in the text.
The implementation is based on work in the rope-experiment repository, where different implentations are tested and benchmarked against each other. This implementation is V2. This implementation may change over time if further enhancements are realized.
Performance differences vs. plain string operations are published in the rope-experiment repository.
Documentation
¶
Index ¶
- type Reader
- type Rope
- func (r *Rope) Alter(start, end int, value string) error
- func (r *Rope) ByteLength() int
- func (r *Rope) Insert(position int, value string) error
- func (r *Rope) Length() int
- func (r *Rope) NewReader() io.Reader
- func (r *Rope) Rebalance()
- func (r *Rope) Remove(start, end int) error
- func (r *Rope) String() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader implements io.Reader and io.WriterTo for a Rope rope
type Rope ¶
type Rope struct {
// contains filtered or unexported fields
}
Rope is a data structure that represents a string. Internally, the string is fractured into smaller strings to facilitate faster editing at the expense of memory usage
func CreateRope ¶
CreateRope creates a Rope with the given initial value
func (*Rope) ByteLength ¶
ByteLength returns the number of bytes necessary to store a contiguous representation of the Rope's contents
func (*Rope) NewReader ¶
NewReader returns an `io.Reader` that will allow consuming the rope as a contiguous stream of bytes.
Source Files