Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quasilyte/inltest
Package inltest helps you to test that performance-sensitive funcs are inlineable.
https://github.com/quasilyte/inltest
go golang inline inlining library performance testing
Last synced: 11 days ago
JSON representation
Package inltest helps you to test that performance-sensitive funcs are inlineable.
- Host: GitHub
- URL: https://github.com/quasilyte/inltest
- Owner: quasilyte
- License: mit
- Created: 2018-11-18T14:04:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-30T09:18:42.000Z (almost 6 years ago)
- Last Synced: 2024-10-11T11:48:20.390Z (27 days ago)
- Topics: go, golang, inline, inlining, library, performance, testing
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/Quasilyte/inltest)
[](https://godoc.org/github.com/Quasilyte/inltest)
[](https://travis-ci.org/Quasilyte/inltest)
# inltest
Package inltest helps you to test that performance-sensitive funcs are inlineable.
Usually should be used inside your tests, so you can see that some functions are
not inlineable anymore due to, for example, cost increase during the last refactoring.
> Note: please don't try to interpret returned "not inlined resons" slice.
> Its contents may change from one Go version to another.
> The only information you can safely rely on is whether function
> is inlineable or not. And usually you want all functions from the
> input map to be inlineable (otherwise why would you include them)?
## Installation
```bash
go get -v github.com/Quasilyte/inltest
```
## Example
```go
package main
import (
"fmt"
"log"
"github.com/Quasilyte/inltest"
)
func main() {
issues, err := inltest.CheckInlineable(map[string][]string{
"github.com/Quasilyte/inltest": {
"CheckInlineable",
"nonexisting",
},
// errors.New is inlineable => gives no issue.
"errors": {
"New",
},
"strings": {
"(*Builder).WriteRune",
},
})
if err != nil {
log.Fatalf("inltest failed: %v", err)
}
for _, issue := range issues {
fmt.Println(issue)
}
}
```
For tests, you can do something like:
```go
func TestInlining(t *testing.T) {
if testing.Short() {
t.Skip("skipping in short mode")
}
issues, err := CheckInlineable(map[string][]string{
"my/important/pkg": {
"func1",
"func2",
"(*Value).Set",
},
})
if err != nil {
t.Fatalf("inltest failed: %v", err)
}
for _, issue := range issues {
t.Error(issue)
}
}
```