A constant that states whether larger or smaller measurements, relative to a set baseline, indicate better performance.
enum Polaritycase prefersLargerA performance measurement where a larger value, relative to a set baseline, indicates better performance.
case prefersSmallerA performance measurement where a smaller value, relative to a set baseline, indicates better performance.
import BenchmarkBenchmark allows you to easily create sophisticated Swift performance benchmarks
enum BenchmarkMetricMetrics supported by benchmark.
case prefersLargerA performance measurement where a larger value, relative to a set baseline, indicates better performance.
case prefersSmallerA performance measurement where a smaller value, relative to a set baseline, indicates better performance.
init(from decoder: any Decoder) throws case custom(_: String, polarity: BenchmarkMetric.Polarity = .prefersSmaller, useScalingFactor: Bool = true)Custom metric
var polarity: BenchmarkMetric.Polarity { get }Indicates whether larger or smaller measurements, relative to a set baseline, indicate better performance.
init?(argument: String) init(from decoder: any Decoder) throws static var all: [BenchmarkMetric] { get }A collection of all benchmarks supported by this library.
static var arc: [BenchmarkMetric] { get }A collection of ARC metrics
static var `default`: [BenchmarkMetric] { get }The default collection of metrics used for a benchmark.
static var disk: [BenchmarkMetric] { get }A collection of disk benchmarks.
static var extended: [BenchmarkMetric] { get }A collection of extended system benchmarks.
static var maxIndex: Int { get }static var memory: [BenchmarkMetric] { get }A collection of memory benchmarks.
static var microbenchmark: [BenchmarkMetric] { get }A small collection of metrics used for microbenchmarks only interested in CPU
static var system: [BenchmarkMetric] { get }A collection of system benchmarks.
var countable: Bool { get }var description: String { get }var index: Int { get }var rawDescription: String { get }var useScalingFactor: Bool { get }True if this metric should be scaled to the scalingFactor if looking at scaled output.
static func == (lhs: BenchmarkMetric, rhs: BenchmarkMetric) -> Bool func hash(into hasher: inout Hasher) func metricFor(index: Int) -> BenchmarkMetric protocol DecodableA type that can decode itself from an external representation.
protocol EncodableA type that can encode itself to an external representation.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.