runtime/io.matthewnelson.kmp.tor.runtime/TorRuntime/Environment

Environment

class Environment : FileID(source)

The environment for which TorRuntime operates.

Specified directories/files are utilized by TorRuntime.BuilderScope.config to create a minimum viable TorConfig.

The Environment API is mostly based around configuration options that are, or could be, platform-specific. This means less platform-specific code, and more commonMain code.

See also

Types

Link copied to clipboard
class BuilderScope
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@JvmField
val cacheDirectory: File
Link copied to clipboard
@JvmField
@Volatile
var debug: Boolean

Toggle to dispatch RuntimeEvent.LOG.DEBUG and TorEvent.DEBUG or not.

Link copied to clipboard
open override val fid: String

An ID string which is based off of a file path.

Link copied to clipboard
@get:JvmStatic
@get:JvmName(name = "fidEllipses")
val FileID.fidEllipses: String

Returns the first and last 4 characters of the fid concatenated together with an ellipses between.

Link copied to clipboard
@JvmField
val loader: ResourceLoader.Tor
Link copied to clipboard
@JvmField
val workDirectory: File

Functions

Link copied to clipboard
@JvmStatic
@JvmOverloads
@JvmName(name = "fidString")
fun FileID.toFIDString(defaultClassName: String = "Unknown", includeHashCode: Boolean = true): String

Helper for overriding a class's toString function.