porfirion / trie Goto Github PK

Hi @porfirion

I would like to submit a PR to make this library generic-able. By turning most part of the library into generic type/function and make a alias for backward-compatibility.

For example:

// Turn Trie into TrieGen with type parameter
type TrieGen[T any] struct {
	Prefix   []byte
	Value    *T // Here we use *T, not  T, for optional value
	Children *[256]*TrieGen[T]
}
// Other methods on TrieGen are modified too, with input/output type T, not *T

// Provide existing interface Trie as a type alias, ValueType will be removed directly
type Trie = TrieGen[interface{}] 

This interface provide easier, less error-prone interface for most types, since user don't need to 1. type assert and 2. dereference pointer.

func SomeJob() {
	var routes *TrieGen[string] = BuildFromMap[string](map[string]string{
		"/user/info": "some-user-info",
	})
	content, _, ok := routes.SearchPrefixInString("/user")
	if ok {
		fmt.Println(content)
	}
}

Problem

However, the Trie.Value now has incompatible type chage, from interface{} to *interface{}.

Since Value is a public field for Trie, there may be some existing user who interact with the trie content,
not using public methods from the trie. For these users, the proposed change can broken their code when they upgrade this library.

Do you think this is a good change for this library? If so, I would like to submit a PR for this change. :D
(Actually I already complete the required modification and fix corresponding test cases in my local repo.)

Hope for your kind response.
And thanks for this great library, I learned a lot from it. :D

If we do not care about compatibility, we can just provide:

type Trie[T any] struct {
	Prefix   []byte
	Value    *T
	Children *[256]*Trie[T]
}

Related Information

There is already a fork doing similar change, but the public method of that fork return values in *T, which I don't think a good design decision.

See: https://github.com/MrMelon54/trie