类

class Configuration

public class Configuration <: ToString {
    public init()
}

功能：存储 @Configure 宏生成的 unittest 配置数据的对象。Configuration 是一个类似 HashMap 的类，但它的键不是键和值类型，而是 KeyFor> 类型，和任何给定类型的值。

父类型：

ToString

init()

public init()

功能：构造一个空的实例。

func clone()

public func clone(): Configuration

功能：拷贝一份对象。

返回值：

Configuration - 拷贝的对象。

func get<T>(KeyFor<T>)

public func get<T>(key: KeyFor<T>): ?T

功能：获取 key 对应的值。

T 为泛型参数，用于在对象中查找对应类型的值。

参数：

key: KeyFor - 配置项的键值。

返回值：

?T - 未找到时返回 None，找到对应类型及名称的值时返回 Some<T>(v) 。

func getByName<T>(name: String): ?T

public func getByName<T>(name: String): ?T

功能：获取 key 对应的值。

T 为泛型参数，用于在对象中查找对应类型的值。

参数：

name: String - 键名称。

func remove<T>(KeyFor<T>)

public func remove<T>(key: KeyFor<T>): ?T

功能：删除对应键名称和类型的值。

参数：

key: KeyFor - 配置项的键值。

返回值：

?T - 当存在该值时返回该值，当不存在时返回 None。

func removeByName<T>(String)

public func removeByName<T>(name: String): ?T

功能：删除对应键名称和类型的值。

参数：

key: String - 键名称。

返回值：

?T - 当存在该值时返回该值，当不存在时返回 None。

func set<T>(KeyFor<T>, T)

public func set<T>(key: KeyFor<T>, value: T)

功能：给对应键名称和类型设置值。

参数：

key: KeyFor - 配置项的键值。
value: T - 键值。

func setByName<T>(name: String, value: T)

public func setByName<T>(name: String, value: T): Unit

功能：给对应键名称和类型设置值。

参数：

name: String - 键名称。
value: T - 键值。

func toString()

public func toString(): String

功能：该对象的字符化对象，当内部对象未实现 ToString 接口时，输出 '<not printable>' 。

返回值：

String - 字符串。

static func merge(Configuration, Configuration)

public static func merge(parent: Configuration, child: Configuration): Configuration

功能：合并 child 到 parent 配置中。其中如有同名键值 child 覆盖 parent 。

参数：

parent:Configuration - 需要合并的配置
child:Configuration - 需要合并的配置

返回值：

Configuration - 合并完成的配置

extend Configuration <: BenchmarkConfig

extend Configuration <: BenchmarkConfig {}

功能：为 Configuration 扩展 BenchmarkConfig 接口。

父类型：

BenchmarkConfig

func batchSize(Int64)

public func batchSize(b: Int64)

功能：配置性能测试时一个批次的执行次数。

参数：

b: Int64 - 执行次数。

func batchSize(Range<Int64>)

public func batchSize(x: Range<Int64>)

功能：配置性能测试时一个批次的执行次数范围。

参数：

b: Range<Int64> - 执行次数范围。

func explicitGC(ExplicitGcType)

public func explicitGC(x: ExplicitGcType)

功能：配置性能测试时执行 GC 的方式。

参数：

x: ExplicitGcType - GC 执行的方式。

func minBatches(Int64)

public func minBatches(x: Int64)

功能：配置性能测试时最少的批次数。

参数：

x: Int64 - 最少的批次数。

func minDuration(Duration)

public func minDuration(x: Duration)

功能：配置性能测试时最短的执行时长。

参数：

x: Duration - 最短的执行时长。

func warmup(Int64)

public func warmup(x: Int64)

功能：配置性能测试时预热的秒数。

参数：

x: Int64 - 预热的秒数。

func warmup(Duration)

public func warmup(x: Duration)

功能：配置性能测试时预热的时长。

参数：

x: Duration - 预热的时长。

class ConfigurationKey

abstract sealed class ConfigurationKey <: Equatable<ConfigurationKey> & Hashable {
    public override operator func !=(that: ConfigurationKey)
}

功能：配置项的键值对象。提供判等及 hashCode 方法。

父类型：

func equals(ConfigurationKey)

protected func equals(that: ConfigurationKey): Bool

功能：判断是否相等。

参数：

that: ConfigurationKey - 被对比的对象。

返回值：

Bool - 是否相等。

func hashCode

public override func hashCode(): Int64

功能：获取 hashCode 值。

返回值：

Int64 - hashCode 值。

operator func ==(ConfigurationKey)

public override operator func ==(that: ConfigurationKey)

功能：判等。

参数：

that: ConfigurationKey - 被对比的数据

返回值:

Bool - 是否相等。

public override operator func !=(that: ConfigurationKey)

public override operator func !=(that: ConfigurationKey)

功能：判不等。

参数：

that: ConfigurationKey - 被对比的数据

返回值:

Bool - 是否不相等。

class PrettyPrinter

public abstract class PrettyPrinter {
    public PrettyPrinter(let indentationSize!: UInt64 = 4, let startingIndent!: UInt64 = 0)
}

功能：拥有颜色和对齐、缩进控制的打印器。

init(UInt64,UInt64)

public PrettyPrinter(let indentationSize!: UInt64 = 4, let startingIndent!: UInt64 = 0)

功能：构造器。

参数：

indentationSize!: UInt64 - 一个缩进的空格数。
startingIndent!: UInt64 - 开头的缩进个数。

prop isTopLevel

public prop isTopLevel: Bool

功能：获取是否在打印的缩进顶层。

类型：Bool 。

func append(String)

public func append(text: String): PrettyPrinter

功能：增加一个字符串到打印器中。不支持多行字符串，对多行字符串不支持缩进。

参数：

text: String - 被增加的字符串。

返回值：

PrettyPrinter - 打印器。

func append<PP>(PP)where PP <: PrettyPrintable

public func append<PP>(value: PP): PrettyPrinter where PP <: PrettyPrintable

功能：增加一个实现了 PrettyPrintable 的对象到打印器中。

参数：

value: PP - 一个实现了 PrettyPrintable 的对象。

返回值：

PrettyPrinter - 打印器。

func appendCentered(String, UInt64)

public func appendCentered(text: String, space: UInt64): PrettyPrinter

功能：增加一个字符串到打印器中。居中对齐至指定字符数，不足的字符由空格补齐。不支持多行字符串，对多行字符串不支持缩进。

参数：

text: String - 被增加的字符串。
space: UInt64 - 对齐的字符数量。

返回值：

PrettyPrinter - 打印器。

func appendLeftAligned(String, UInt64)

public func appendLeftAligned(text: String, space: UInt64): PrettyPrinter

功能：增加一个字符串到打印器中。左对齐至指定字符数，不足的字符由空格补齐。不支持多行字符串，对多行字符串不支持缩进。

参数：

text: String - 被增加的字符串。
space: UInt64 - 对齐的字符数量。

返回值：

PrettyPrinter - 打印器。

func appendLine(String): PrettyPrinter

public func appendLine(text: String): PrettyPrinter

功能：增加一个字符串到打印器中，跟着一个换行符。

参数：

text: String - 被增加的字符串。

返回值：

PrettyPrinter - 打印器。

func appendLine<PP>(PP) where PP <: PrettyPrintable

public func appendLine<PP>(value: PP): PrettyPrinter where PP <: PrettyPrintable

功能：增加一个实现了 PrettyPrintable 的对象到打印器中，跟着一个换行符。

参数：

value: PP - 一个实现了 PrettyPrintable 的对象。

返回值：

PrettyPrinter - 打印器。

func appendRightAligned(String, UInt64)

public func appendRightAligned(text: String, space: UInt64): PrettyPrinter

功能：增加一个字符串到打印器中。右对齐至指定字符数。不支持多行字符串，对多行字符串不支持缩进。

参数：

text: String - 被增加的字符串。
space: UInt64 - 对齐的字符数量。

返回值：

PrettyPrinter - 打印器。

func colored(Color, body: () -> Unit)

public func colored(color: Color, body: () -> Unit): PrettyPrinter

功能：对闭包中给打印器增加的字符串指定颜色。常见的用法如下：

pp.colored(RED) {
    pp.appendLine("1")
    pp.appendLine("2")
    pp.appendLine("3")
}

此时字符串 "1" "2" "3" 均被打印为红色。

参数：

color: Color - 指定打印的颜色。
body: () -> Unit - 添加字符串的闭包。

返回值：

PrettyPrinter - 打印器。

func colored(Color, String)

public func colored(color: Color, text: String): PrettyPrinter

功能：对给打印器增加的字符串指定颜色。

参数：

color: Color - 指定打印的颜色。
text: String - 添加的字符串。

返回值：

PrettyPrinter - 打印器。

func customOffset(UInt64, body: () -> Unit)

public func customOffset(symbols: UInt64, body: () -> Unit): PrettyPrinter

功能：对闭包中给打印器增加的字符串指定额外缩进的个数。常见的用法如下：

pp.customOffset(5) {
    pp.appendLine("1")
    pp.appendLine("2")
    pp.appendLine("3")
}

此时字符串 "1" "2" "3" 均额外缩进5个字符。

参数：

symbols: UInt64 - 指定缩进个数。
body: () -> Unit - 添加字符串的闭包。

返回值：

PrettyPrinter - 打印器。

func indent(body: () -> Unit)

public func indent(body: () -> Unit): PrettyPrinter

功能：对闭包中给打印器增加的字符串指定额外缩进一次。常见的用法如下：

pp.indent {
    pp.appendLine("1")
    pp.appendLine("2")
    pp.appendLine("3")
}

此时字符串 "1" "2" "3" 均额外缩进一次。

参数：

body: () -> Unit - 添加字符串的闭包。

返回值：

PrettyPrinter - 打印器。

func indent(UInt64, body: () -> Unit)

public func indent(indents: UInt64, body: () -> Unit): PrettyPrinter

功能：对闭包中给打印器增加的字符串指定额外缩进指定次数。常见的用法如下：

pp.indent(2) {
    pp.appendLine("1")
    pp.appendLine("2")
    pp.appendLine("3")
}

此时字符串 "1" "2" "3" 均额外缩进2次。

参数：

indents: UInt64 - 指定额外缩进的次数。
body: () -> Unit - 添加字符串的闭包。

返回值：

PrettyPrinter - 打印器。

func newLine()

public func newLine(): PrettyPrinter

功能：增加新行。

返回值：

PrettyPrinter - 打印器。

func put(String)

protected func put(s: String): Unit

功能：打印字符串。

参数：

s: String - 需打印的字符串。

func putNewLine()

protected open func putNewLine(): Unit

功能：打印新行。

func setColor(Color)

protected func setColor(color: Color): Unit

功能：设置颜色。

参数：

color: Color - 指定的颜色。

class PrettyText

public class PrettyText <: PrettyPrinter & PrettyPrintable & ToString {
    public init()
    public init(string: String)
}

功能：类似构造器的类，用于存储打印的输出。主要用途是中间存储和传递这些值。实现 PrettyPrinter（可以打印到）和 PrettyPrintable（可以从中打印）

父类型：

init()

public init()

功能：默认构造器，生成一个空的对象。

init(String)

public init(string: String)

功能：构造器，生成一个以入参开头的文本构造器。

参数：

string : String - 希望放入打印文本开头的字符串。

func isEmpty()

public func isEmpty(): Bool

功能：返回当前构造器是否为空，即未有值传入给构造器。

返回值：

Bool - 未有内容传入时返回 true ，否则返回 false 。

func pprint(PrettyPrinter)

public func pprint(to: PrettyPrinter): PrettyPrinter

功能：打印信息到打印器上。

参数：

to: PrettyPrinter - 打印器。

返回值：

PrettyPrinter - 打印器。

func toString()

public func toString(): String

功能：打印文本到字符串上。

返回值：

String - 打印文本的字符串。

static func of<PP>(PP) where PP <: PrettyPrintable

public static func of<PP>(pp: PP) where PP <: PrettyPrintable

功能：通过打印从 PrettyPrintable 创建 PrettyText。

参数：

pp: PP - 一个实现了 PrettyPrintable 的类型。

返回值：

PrettyText - 打印文本对象。

仓颉编程语言库 API