AutoTweaker API/io.github.autotweaker.api.base

Package-level declarations

Types

BooleanSetting

abstract class BooleanSetting(default: Boolean, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValBoolean>

能够让 SettingDef 实现省几行代码的基类，示例：

ByteSetting

abstract class ByteSetting(default: Byte, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValByte>

能够让 SettingDef 实现省几行代码的基类，示例：

CatchingResult

@JvmInline

value class CatchingResult<out T>

Result 的包装，泛型 T 在类级别，提供成员函数来弥补 Result 错误处理方面的缺陷，并转发 Result 的标准 API。为了避免 <E, T> 导致编译器无法推断泛型类型，包装 Result，成员函数就不需要 T 了。

CharSetting

abstract class CharSetting(default: Char, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValChar>

能够让 SettingDef 实现省几行代码的基类，示例：

DoubleSetting

abstract class DoubleSetting(default: Double, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValDouble>

能够让 SettingDef 实现省几行代码的基类，示例：

FloatSetting

abstract class FloatSetting(default: Float, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValFloat>

能够让 SettingDef 实现省几行代码的基类，示例：

I18nBase

abstract class I18nBase(first: Pair<Locale, String>, more: Pair<Locale, String>) : I18nDef

能够让 I18nDef 实现省几行代码的基类，示例：

IntSetting

abstract class IntSetting(default: Int, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValInt>

能够让 SettingDef 实现省几行代码的基类，示例：

LongSetting

abstract class LongSetting(default: Long, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValLong>

能够让 SettingDef 实现省几行代码的基类，示例：

Mutable

class Mutable<T>

包装一个不可变数据，基于 ReentrantMutex 提供并发安全的更新方式。同时支持在数据被修改时执行 lambda。

ReentrantMutex

class ReentrantMutex : Traceable

基于 Mutex 的可重入锁，相同协程以及子协程都允许重入。

SettingBase

abstract class SettingBase<out V : SettingValue<*>>(desc: Pair<Locale, String>) : SettingDef<V>

通常使用此文件中的其他基类，如 StringSetting。

ShortIdGenerator

object ShortIdGenerator

生成一个自增短 id，用于日志记录。

ShortIdMapper

object ShortIdMapper

将 UUID 映射为短 id，在内存中保存映射。

ShortSetting

abstract class ShortSetting(default: Short, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValShort>

能够让 SettingDef 实现省几行代码的基类，示例：

StringSetting

abstract class StringSetting(default: String, desc: Pair<Locale, String>) : SettingBase<SettingValue.ValString>

能够让 SettingDef 实现省几行代码的基类，示例：

Properties

val en: Locale

语言代码 en。

val zh: Locale

语言代码 zh_CN。

Functions

catching

inline fun <T> TraceRecorder.catching(block: () -> T): CatchingResult<T>

inline fun <T, R> T.catching(recorder: TraceRecorder, block: T.() -> R): CatchingResult<R>

runCatching 的封装，onFailure 自动记录异常到 TraceRecorder，需要调用方实现 io.github.autotweaker.api.Traceable。

fun en(text: String): Pair<Locale, String>

使用 text 构造一个语言为 en 的 Pair<Locale, String>。

getOrDefault

fun <R, T : R> CatchingResult<T>.getOrDefault(defaultValue: R): R

getOrElse

inline fun <R, T : R> CatchingResult<T>.getOrElse(onFailure: (Throwable) -> R): R

recover

inline fun <R, T : R> CatchingResult<T>.recover(transform: (Throwable) -> R): CatchingResult<R>

recoverException

inline fun <E : Throwable, R, T : R> CatchingResult<T>.recoverException(transform: (E) -> R): CatchingResult<R>

如果异常为 E，对 T 进行 transform，返回新的成功 CatchingResult。

recoverIf

inline fun <R, T : R> CatchingResult<T>.recoverIf(test: (Throwable) -> Boolean, transform: (Throwable) -> R): CatchingResult<R>

如果 test，对 T 进行 transform，返回新的成功 CatchingResult

unifiedDiff

fun unifiedDiff(oldContent: String?, newContent: String): String?

fun zh(text: String): Pair<Locale, String>

使用 text 构造一个语言为 zh 的 Pair<Locale, String>。