stringutil

Documentation

Index

• func ConvertListToMap(list []string, makeIfEmpty bool) map[string]struct{}
• func ConvertMapKeysToList(mapData map[string]struct{}, doSort bool) []string
• func DeduplicateList(list []string, makeIfEmpty bool) ([]string, map[string]struct{})
• type StringDeduplicator
  • func NewStringDeduplicator(lock bool) *StringDeduplicator
  • func (d *StringDeduplicator) Clear()
  • func (d *StringDeduplicator) DeDuplicate(str string) string
  • func (d *StringDeduplicator) DeleteUnregistered()
  • func (d *StringDeduplicator) GetStatistics() StringDuplicationStatistics
  • func (d *StringDeduplicator) Register(str string)
• type StringDuplicationStatistics

Functions

func ConvertListToMap

func ConvertListToMap(list []string, makeIfEmpty bool) map[string]struct{}

ConvertListToMap will convert list entries to map keys. If makeIfEmpty is true then a map is made for an empty list, otherwise nil is returned.

func ConvertMapKeysToList

func ConvertMapKeysToList(mapData map[string]struct{}, doSort bool) []string

ConvertMapKeysToList will return a list of map keys.

func DeduplicateList

func DeduplicateList(list []string, makeIfEmpty bool) (
	[]string, map[string]struct{})

DeduplicateList will return a list of strings with duplicates removed, preserving the (initial) ordering of the input list. If the input list has no duplicates, it is simply returned rather than returning a copy of the list. The unique map keys are also returned. If makeIfEmpty, a non-nil map is always returned.

Types

type StringDeduplicator

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

func NewStringDeduplicator

func NewStringDeduplicator(lock bool) *StringDeduplicator

NewStringDeduplicator will create a StringDeduplicator which may be used to eliminate duplicate string contents. It maintains an internal map of unique strings. If lock is true then each method call will take an exclusive lock.

func (*StringDeduplicator) Clear

func (d *StringDeduplicator) Clear()

Clear will clear the internal map and statistics.

func (*StringDeduplicator) DeDuplicate

func (d *StringDeduplicator) DeDuplicate(str string) string

DeDuplicate will return a string which has the same contents as str. This method should be called for every string in the application.

func (*StringDeduplicator) DeleteUnregistered

func (d *StringDeduplicator) DeleteUnregistered()

DeleteUnregistered will delete all strings not previously registered with Register. This will also delete the previously registered strings. This may be used for garbage collection.

func (*StringDeduplicator) GetStatistics

func (d *StringDeduplicator) GetStatistics() StringDuplicationStatistics

GetStatistics will return de-duplication statistics.

func (*StringDeduplicator) Register

func (d *StringDeduplicator) Register(str string)

Register will register the specified string to indicate it is used, so that a later call to DeleteUnregistered will not delete it. This method should be called for every string in the application.

type StringDuplicationStatistics

type StringDuplicationStatistics struct {
	DuplicateBytes   uint64
	DuplicateStrings uint64
	UniqueBytes      uint64
	UniqueStrings    uint64
}