KSLog/kslog/dev.inmo.kslog.common/-k-s-log.html
2024-08-27 13:15:58 +00:00

84 lines
18 KiB
HTML

<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>KSLog</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../index.html">
kslog
</a>
</div>
<div class="library-version">
1.3.6 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":dokkaHtml/commonMain">common</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/jvmMain">jvm</button>
</div>
</div>
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
</div>
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="kslog::dev.inmo.kslog.common//KSLog/#kotlin.Function4[dev.inmo.kslog.common.LogLevel,kotlin.String?,kotlin.Any,kotlin.Throwable?,kotlin.Unit]/PointingToDeclaration//995916586">
<div class="breadcrumbs"><a href="../../index.html">kslog</a><span class="delimiter">/</span><a href="index.html">dev.inmo.kslog.common</a><span class="delimiter">/</span><span class="current">KSLog</span></div>
<div class="cover ">
<h1 class="cover"><span><span>KSLog</span></span></h1>
</div>
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":dokkaHtml/commonMain" data-filterable-set=":dokkaHtml/commonMain" data-active="" data-toggle=":dokkaHtml/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":dokkaHtml/jvmMain" data-filterable-set=":dokkaHtml/jvmMain" data-toggle=":dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">performLogCallback<span class="token operator">: </span><a href="-simple-k-s-log-callback/index.html">SimpleKSLogCallback</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-callback-k-s-log/index.html">CallbackKSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/CallbackKSLog.kt#L20">source</a>)</span></span></div><p class="paragraph">Creating <a href="-callback-k-s-log/index.html">CallbackKSLog</a> using <a href="-k-s-log.html">performLogCallback</a> as an argument for constructor</p><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/KSLog.kt#L99">source</a>)</span></span></div><p class="paragraph">Simple builder for <a href="-default-k-s-log/index.html">DefaultKSLog</a> logger based on <a href="-k-s-log.html">defaultTag</a></p><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/KSLog.kt#L106">source</a>)</span></span></div><p class="paragraph">Simple builder for <a href="-default-k-s-log/index.html">DefaultKSLog</a> logger based on <a href="-k-s-log.html">defaultTag</a> and <a href="-k-s-log.html">messageFormatter</a></p><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">levels<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><a href="-log-level/index.html">LogLevel</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/KSLog.kt#L128">source</a>)</span></span></div><p class="paragraph">Building logger using <a href="-k-s-log/index.html">KSLog</a> builder based on <a href="-k-s-log.html">defaultTag</a> and <a href="-k-s-log.html">messageFormatter</a>. This logger will also filter incoming levels: only levels passed in <a href="-k-s-log.html">levels</a> param will be logged</p><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">firstLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter ">secondLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>otherLevels<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/KSLog.kt#L143">source</a>)</span></span></div><p class="paragraph">Building logger using <a href="-k-s-log/index.html">KSLog</a> builder based on <a href="-k-s-log.html">defaultTag</a> and <a href="-k-s-log.html">messageFormatter</a>. This logger will also filter incoming levels: only levels passed in <a href="-k-s-log.html">firstLevel</a>, <a href="-k-s-log.html">secondLevel</a> and <a href="-k-s-log.html">otherLevels</a> param will be logged</p><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">minLoggingLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/commonMain/kotlin/KSLog.kt#L155">source</a>)</span></span></div><p class="paragraph">Building logger using <a href="-k-s-log/index.html">KSLog</a> builder based on <a href="-k-s-log.html">defaultTag</a> and <a href="-k-s-log.html">messageFormatter</a>. This logger will also filter incoming levels: only levels above <a href="-k-s-log.html">minLoggingLevel</a> will be logged</p></div><div class="content sourceset-dependent-content" data-togglable=":dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/logging/Logger.html">Logger</a><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-callback-k-s-log/index.html">CallbackKSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/jvmMain/kotlin/ActualLogger.kt#L38">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/logging/Logger.html">Logger</a><span class="token punctuation">, </span></span><span class="parameter ">levels<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><a href="-log-level/index.html">LogLevel</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/jvmMain/kotlin/ActualLogger.kt#L47">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/logging/Logger.html">Logger</a><span class="token punctuation">, </span></span><span class="parameter ">firstLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter ">secondLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>otherLevels<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/jvmMain/kotlin/ActualLogger.kt#L57">source</a>)</span></span></div><div class="symbol monospace"><span class="token keyword">fun </span><a href="-k-s-log.html"><span class="token function">KSLog</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTag<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/logging/Logger.html">Logger</a><span class="token punctuation">, </span></span><span class="parameter ">minLoggingLevel<span class="token operator">: </span><a href="-log-level/index.html">LogLevel</a><span class="token operator"> = </span>LogLevel.values().first()<span class="token punctuation">, </span></span><span class="parameter ">messageFormatter<span class="token operator">: </span><a href="-message-formatter/index.html">MessageFormatter</a><span class="token operator"> = </span>defaultMessageFormatter</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-k-s-log/index.html">KSLog</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/KSLog/blob/master//src/jvmMain/kotlin/ActualLogger.kt#L66">source</a>)</span></span></div></div> </div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</div>
</body>
</html>