couchbase-lite-ee/kotbase/LogFileConfiguration

LogFileConfiguration

expect class LogFileConfiguration(directory: String)(source)

A class that describes the file configuration for the FileLogger class. Once a configuration has been assigned to a Logger, it becomes read-only: an attempt to mutate it will cause an exception. To change the configuration of a logger, copy its configuration, mutate the copy and then use it to replace the loggers current configuration.

actual class LogFileConfiguration(directory: String) : DelegatedClass<<Error class: unknown class>> (source)

actual class LogFileConfiguration(val directory: String)(source)

Constructors

LogFileConfiguration

expect constructor(directory: String)

Constructs a file configuration object with the given directory

expect constructor(config: LogFileConfiguration)

Constructs a file configuration object based on another one so that it may be modified

expect constructor(directory: String, config: LogFileConfiguration?)

Constructs a file configuration object based on another one but changing the directory

actual constructor(directory: String)

actual constructor(config: LogFileConfiguration)

actual constructor(directory: String, config: LogFileConfiguration?)

actual constructor(directory: String)

actual constructor(config: LogFileConfiguration)

actual constructor(directory: String, config: LogFileConfiguration?)

Properties

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

newConfig

fun LogFileConfiguration?.newConfig(directory: String? = null, maxSize: Long? = null, maxRotateCount: Int? = null, usePlainText: Boolean? = null): LogFileConfiguration

Create a LogFileConfiguration, overriding the receiver's values with the passed parameters:

setMaxRotateCount

expect fun setMaxRotateCount(maxRotateCount: Int): LogFileConfiguration

Sets the number of rotated logs that are saved. For instance, if the value is 1 then 2 logs will be present: the 'current' log and the previous 'rotated' log. The default value is 1.

actual fun setMaxRotateCount(maxRotateCount: Int): LogFileConfiguration

setMaxSize

expect fun setMaxSize(maxSize: Long): LogFileConfiguration

Sets the max size of the log file in bytes. If a log file passes this size then a new log file will be started. This number is a best effort and the actual size may go over slightly. The default size is 500Kb.

actual fun setMaxSize(maxSize: Long): LogFileConfiguration

setUsePlaintext

expect fun setUsePlaintext(usePlaintext: Boolean): LogFileConfiguration

Sets whether or not CBL logs in plaintext. The default (false) is to log in a binary encoded format that is more CPU and I/O friendly. Enabling plaintext is not recommended in production.

actual fun setUsePlaintext(usePlaintext: Boolean): LogFileConfiguration

toString

open override fun toString(): String