Text

README

golang-stringbuilder

A string builder that has similar capabilities as the one from C#. The goal is to have a straightforward API that lets you work with strings easily.

Install

To install the package, call:

go get -u github.com/linkdotnet/golang-stringbuilder

Next import the package:

import ( "github.com/linkdotnet/golang-stringbuilder" )

Quickstart

The API derives from the C# StringBuilder. You can easily append strings or single runes.

func main() {
	sb := Text.StringBuilder{}
	sb.Append("Hello")
	sb.Append(" ")
	sb.Append("World")
	fmt.Println(sb.ToString())
}

Also more advanced use cases where you want to insert an arbitrary word at an arbitrary position are possible.

sb := NewStringBuilderFromString("Hello World")
sb.Insert(5, " my dear")
output := sb.ToString() // Hello my dear World

The StringBuilder also implements the io.Writer interface so it can be use with fmt.Fprintf and friends:

s := &StringBuilder{}

for i := 3; i >= 1; i-- {
	fmt.Fprintf(s, "%d...", i)
}

s.Append("lift off")
fmt.PrintLn(s.ToString()) // Prints 3...2...1...lift off

Benchmark

Check out the implementation of the benchmark in the corresponding file. Here are some results:

goos: darwin
goarch: arm64
pkg: github.com/linkdotnet/golang-stringbuilder
BenchmarkStringBuilderConcat
BenchmarkStringBuilderConcat-10           343710              3394 ns/op            4352 B/op          5 allocs/op
BenchmarkStringConcat
BenchmarkStringConcat-10                 1000000              1113 ns/op            6720 B/op         24 allocs/op
BenchmarkGoStringBuilderConcat
BenchmarkGoStringBuilderConcat-10        4204142               278.4 ns/op          1448 B/op          6 allocs/op

Documentation

Index

• type StringBuilder
  • func NewStringBuilder(initialCapacity int) *StringBuilder
  • func NewStringBuilderFromString(text string) *StringBuilder
  • func (s *StringBuilder) Append(text string) *StringBuilder
  • func (s *StringBuilder) AppendBool(flag bool) *StringBuilder
  • func (s *StringBuilder) AppendInt(integer int) *StringBuilder
  • func (s *StringBuilder) AppendLine(text string) *StringBuilder
  • func (s *StringBuilder) AppendList(words []string) *StringBuilder
  • func (s *StringBuilder) AppendRune(char rune) *StringBuilder
  • func (s *StringBuilder) AsRuneArray() []rune
  • func (s *StringBuilder) AsRuneSlice() []rune
  • func (s *StringBuilder) Clear()
  • func (s *StringBuilder) FindAll(text string) []int
  • func (s *StringBuilder) FindFirst(text string) int
  • func (s *StringBuilder) FindLast(text string) int
  • func (s *StringBuilder) Insert(index int, text string) error
  • func (s *StringBuilder) Len() int
  • func (s *StringBuilder) Remove(start int, length int) error
  • func (s *StringBuilder) Replace(oldValue string, newValue string) *StringBuilder
  • func (s *StringBuilder) ReplaceRune(oldValue rune, newValue rune) *StringBuilder
  • func (s *StringBuilder) Reverse() *StringBuilder
  • func (s *StringBuilder) RuneAt(index int) rune
  • func (s *StringBuilder) SetRuneAt(index int, val rune) error
  • func (s *StringBuilder) Substring(start, end int) (string, error)
  • func (s *StringBuilder) ToString() string
  • func (s *StringBuilder) Trim(chars ...rune) *StringBuilder
  • func (s *StringBuilder) TrimEnd(chars ...rune) *StringBuilder
  • func (s *StringBuilder) TrimStart(chars ...rune) *StringBuilder
  • func (s *StringBuilder) Write(p []byte) (int, error)

Types

type StringBuilder

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

func NewStringBuilder

func NewStringBuilder(initialCapacity int) *StringBuilder

Creates a new instance of the StringBuilder with preallocated array

func NewStringBuilderFromString

func NewStringBuilderFromString(text string) *StringBuilder

Creates a new instance of the StringBuilder with a preallocated text

func (*StringBuilder) Append

func (s *StringBuilder) Append(text string) *StringBuilder

Appends a text to the StringBuilder instance

func (*StringBuilder) AppendBool

func (s *StringBuilder) AppendBool(flag bool) *StringBuilder

Appends a single boolean to the StringBuilder instance

func (*StringBuilder) AppendInt

func (s *StringBuilder) AppendInt(integer int) *StringBuilder

Appends a single integer to the StringBuilder instance

func (*StringBuilder) AppendLine

func (s *StringBuilder) AppendLine(text string) *StringBuilder

Appends a text and a new line character to the StringBuilder instance

func (*StringBuilder) AppendList

func (s *StringBuilder) AppendList(words []string) *StringBuilder

Appends a list of strings to the StringBuilder instance

func (*StringBuilder) AppendRune

func (s *StringBuilder) AppendRune(char rune) *StringBuilder

Appends a single character to the StringBuilder instance

func (*StringBuilder) AsRuneArray

func (s *StringBuilder) AsRuneArray() []rune

Returns the internal array of the string builder. Be careful as this returns the internal slice. Changes to that will reflect in this string builder instance.

func (*StringBuilder) AsRuneSlice

func (s *StringBuilder) AsRuneSlice() []rune

Returns the string builder as a rune-slice. Be careful as this returns the internal slice. Changes to that will reflect in this string builder instance.

func (*StringBuilder) Clear

func (s *StringBuilder) Clear()

Removes all characters from the current instance. This sets the internal size to 0. The internal array will stay the same.

func (*StringBuilder) FindAll

func (s *StringBuilder) FindAll(text string) []int

Returns all occurrences of the given text in the string builder. Returns an empty if no occurrence found.

func (*StringBuilder) FindFirst

func (s *StringBuilder) FindFirst(text string) int

Returns the first occurrence of the given text in the string builder. Returns -1 if not found

func (*StringBuilder) FindLast

func (s *StringBuilder) FindLast(text string) int

Returns the last occurrence of the given text in the string builder. Returns -1 if not found

func (*StringBuilder) Insert

func (s *StringBuilder) Insert(index int, text string) error

func (*StringBuilder) Len

func (s *StringBuilder) Len() int

Returns the current length of the represented string

func (*StringBuilder) Remove

func (s *StringBuilder) Remove(start int, length int) error

func (*StringBuilder) Replace

func (s *StringBuilder) Replace(oldValue string, newValue string) *StringBuilder

Replaces all occurrences of oldValue with newValue

func (*StringBuilder) ReplaceRune

func (s *StringBuilder) ReplaceRune(oldValue rune, newValue rune) *StringBuilder

Replaces all occurrences of oldValue with newValue

func (*StringBuilder) Reverse

func (s *StringBuilder) Reverse() *StringBuilder

Reverses the characters of a string builder

func (*StringBuilder) RuneAt

func (s *StringBuilder) RuneAt(index int) rune

Gets the rune at the specific position

func (*StringBuilder) SetRuneAt

func (s *StringBuilder) SetRuneAt(index int, val rune) error

Sets the rune at the specific position

func (*StringBuilder) Substring

func (s *StringBuilder) Substring(start, end int) (string, error)

Returns a substring from start (inclusive) to end (exclusive).

func (*StringBuilder) ToString

func (s *StringBuilder) ToString() string

Returns the represented string

func (*StringBuilder) Trim

func (s *StringBuilder) Trim(chars ...rune) *StringBuilder

Trims the given characters from the start and end of the string builder or all whitespaces if no characters are given

func (*StringBuilder) TrimEnd

func (s *StringBuilder) TrimEnd(chars ...rune) *StringBuilder

Trims the given characters from the start of the string builder or all whitespaces if no characters are given

func (*StringBuilder) TrimStart

func (s *StringBuilder) TrimStart(chars ...rune) *StringBuilder

Trims the given characters from the start of the string builder or all whitespaces if no characters are given

func (*StringBuilder) Write

func (s *StringBuilder) Write(p []byte) (int, error)

Implements the io.Writer interface so the StringBuilder can be used with fmt.Printf