api

object api extends Keys

Import the contents of this singleton object to obtain access to most abstractions in the ScalaMeter API.

Import the contents of this singleton object to obtain access to most abstractions in the ScalaMeter API.

Note that some definitions might shadow others, so if you import the contents of this object, you should not import the contents of other packages directly.

This object contains:

  • basic datatypes and singleton objects for writing tests, such as PerformanceTest
  • all the context map keys
  • contents of the execution package
  • contents of the reporting package
  • contents of the persistence package
  • the Executor.Measurer object
  • the RegressionReporter.Tester object
  • the RegressionReporter.Historian object
  • the ChartReporter.ChartFactory object
  • the HtmlReporter.Renderer object
  • and much more...
class Keys
class KeyContainer
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object dsl
Inherited from
Keys
object exec
Inherited from
Keys
object gen
Inherited from
Keys
object machine
Inherited from
Keys
object reports
Inherited from
Keys

Types

type Aggregator[T] = Aggregator[T]
type Bench[T] = Bench[T]
type Context = Context
type DsvReporter[T] = DsvReporter[T]
type Executor[T] = Executor[T]
type Gen[T] = Gen[T]
type Measurer[T] = Measurer[T]
type PGFPlotsReporter[T >: Null] = PGFPlotsReporter[T]
type Reporter[T] = Reporter[T]
type Warmer = Warmer
type benchmark = benchmark
type ctx = ctx
type curve = curve
type disabled = disabled
type gen = gen
type scopeCtx = scopeCtx
type scopes = scopes
type setup = setup
type setupBeforeAll = setupBeforeAll
type teardown = teardown
type teardownAfterAll = teardownAfterAll
type warmup = warmup

Deprecated types

@deprecated("Please use Bench instead", "0.7")
type PerformanceTest[T] = Bench[T]
Deprecated

Value members

Inherited methods

def apply[T](name: String, defaultValue: T)(`evidence$6`: Pickler[T], container: KeyContainer): KeyWithDefaultValue[T]
Inherited from
Keys
def apply[T](name: String)(`evidence$5`: Pickler[T], container: KeyContainer): Key[T]
Inherited from
Keys
def parseKey(keyName: String): Key[_]
Inherited from
KeyContainer

Deprecated fields

@deprecated("Please use Bench instead", "0.7")
Deprecated

Inherited fields

val classpath: KeyWithDefaultValue[ClassPath]
Inherited from
Keys
val containerName: String
Inherited from
KeyContainer
val enclosing: KeyContainer
Inherited from
KeyContainer
val preJDK7: KeyWithDefaultValue[Boolean]
Inherited from
Keys
val scopeFilter: KeyWithDefaultValue[String]
Inherited from
Keys
val verbose: KeyWithDefaultValue[Boolean]
Inherited from
Keys

Implicits

Inherited implicits

implicit def container: KeyContainer
Inherited from
KeyContainer