InProcessTracingMode


@ExperimentalBenchmarkConfigApi
enum InProcessTracingMode : Enum


Configuration for in-process tracing.

By passing this object in MacrobenchmarkRule you can enable capture of in-process traces.

Summary

Enum Values

Disable

Do not include in-process traces.

Require

Enable in-process tracing, which requires the target application to include the androidx.tracing:tracing-wire dependency.

UseIfAvailable

Enable in-process tracing if the app depends on androidx.tracing:tracing-wire.

Public functions

InProcessTracingMode
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<InProcessTracingMode>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

EnumEntries<InProcessTracingMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Enum Values

Disable

@ExperimentalBenchmarkConfigApi
val InProcessTracingMode.DisableInProcessTracingMode

Do not include in-process traces.

Require

@ExperimentalBenchmarkConfigApi
val InProcessTracingMode.RequireInProcessTracingMode

Enable in-process tracing, which requires the target application to include the androidx.tracing:tracing-wire dependency.

If androidx.tracing:tracing-wire is not present in the target application, an exception is thrown during the benchmark.

UseIfAvailable

@ExperimentalBenchmarkConfigApi
val InProcessTracingMode.UseIfAvailableInProcessTracingMode

Enable in-process tracing if the app depends on androidx.tracing:tracing-wire.

Public functions

valueOf

Added in 1.5.0-beta01
fun valueOf(value: String): InProcessTracingMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws
kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Added in 1.5.0-beta01
fun values(): Array<InProcessTracingMode>

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

Public properties

entries

val entriesEnumEntries<InProcessTracingMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.