runtime-core/io.matthewnelson.kmp.tor.runtime.core.config/TorSetting

TorSetting

class TorSetting(source)

Holder for a "setting".

Most TorOption are a single LineItem, but there are some which require "grouping", such as Hidden Services. For example, declaring a Hidden Service in a configuration requires TorOption.HiddenServiceDir be declared first, and a minimum of one TorOption.HiddenServicePort declaration following it. In this case, items would contain all Hidden Service LineItem for that Hidden Service "instance".

Comparison of settings is done such that only the first LineItem (or "root" item) within items is considered.

See also

Types

Link copied to clipboard
abstract class BuilderScope

Base builder scope for higher level implementations.

Link copied to clipboard
object Companion
Link copied to clipboard
class LineItem

Holder of a single configuration line item.

Properties

Link copied to clipboard
@JvmField
val extras: Map<String, Any>

Any extra information about this setting that will be excluded by toString, but may be required elsewhere, such as the kmp-tor:runtime dependency.

Link copied to clipboard
@JvmField
val items: Set<TorSetting.LineItem>

A single, or "group" of LineItem. This will always contain, at a minimum, 1 LineItem. If multiple LineItem are present (i.e. a group setting), the first LineItem is treated as the "root" LineItem for the TorSetting.

Functions

Link copied to clipboard
@JvmStatic
fun TorSetting.toConfig(): TorConfig

Wraps a single TorSetting in TorConfig.