Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imjasonh/tros
tros lets you sort Go structs using reflection. Get it?
https://github.com/imjasonh/tros
Last synced: about 1 month ago
JSON representation
tros lets you sort Go structs using reflection. Get it?
- Host: GitHub
- URL: https://github.com/imjasonh/tros
- Owner: imjasonh
- License: apache-2.0
- Created: 2014-08-06T18:58:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-23T15:09:38.000Z (almost 10 years ago)
- Last Synced: 2024-10-14T16:51:16.040Z (3 months ago)
- Language: Go
- Homepage:
- Size: 309 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`tros` provides methods to sort slices of structs using reflection
[](https://godoc.org/github.com/ImJasonH/tros)
[](https://travis-ci.org/ImJasonH/tros)
Sorting Idiomatically in Go
-----
```
type Thing struct {
Name string
Weight, Height int
Awesome bool
}
func sortThingsByName(things []Thing) {
sort.Sort(byName(things))
}
type byName []Thing
func (s byName) Len() int { return len(s) }
func (s byName) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
func (s byName) Less(i, j int) bool { return s[i].Name < s[j].Name } // Sort by name
// TODO: Support sorting by weight, height, awesomeness, etc.
```
Sorting slices of Go structs idiomatically is easy, if you only intend to do it for a few different fields, and you know what they are ahead of time. Sorting by arbitrary fields means copypasting lots of boilerplate with small nuanced changes.
Sorting with `tros`
-----
```
type Thing struct {
Name string
Weight, Height int
Awesome bool
}
func sortThings(things []Thing) {
fmt.Println("Sorted by name:")
tros.Sort(things, "Name")
fmt.Println(things)
fmt.Println("Sorted by weight:")
tros.Sort(things, "Weight")
fmt.Println(things)
// Sort in reverse order too!
fmt.Println("Sorted by name (reversed):")
tros.Sort(things, "-Name")
fmt.Println(things)
// ...and so on
}
```
With `tros`, you can easily sort slices of structs by the values of arbitrary fields described at runtime, leaving out lots of boring boilerplate.
Custom Sorting
-----
If you want to define your own custom sorting logic, you can have your struct fields implement the [`Lesser`](https://godoc.org/github.com/ImJasonH/tros#Lesser) interface, which `tros` will use to determine ordering.
Caveats
-----
* `tros` uses reflection, and as such is noticeably (~2.5x) slower for sorting than the idiomatic Go way. But for small-to-medium slices, the difference should be negligible. If performance is more important than convenience, use the standard [`sort`](https://godoc.org/sort) package
----------
License
-----
Copyright 2014 Jason Hall
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.