Skip to content
Package inltest helps you to test that performance-sensitive funcs are inlineable.
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis.yml
LICENSE
README.md
example_test.go
go.mod
inltest.go
inltest_test.go

README.md

Go Report Card GoDoc Build Status

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

go get -v github.com/Quasilyte/inltest

Example

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:

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)
	}
}
You can’t perform that action at this time.