MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.common/apply-diff.html
2024-06-19 20:06:26 +00:00

81 lines
17 KiB
HTML

<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>applyDiff</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">
micro_utils.dokka
</a>
</div>
<div class="library-version">
0.21.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</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="micro_utils.dokka::dev.inmo.micro_utils.common//applyDiff/kotlin.collections.MutableList[TypeParam(bounds=[kotlin.Any?])]#dev.inmo.micro_utils.common.Diff[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//-1478683138">
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="index.html">dev.inmo.micro_utils.common</a><span class="delimiter">/</span><span class="current">applyDiff</span></div>
<div class="cover ">
<h1 class="cover"><span>apply</span><wbr></wbr><span><span>Diff</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">diff<span class="token operator">: </span><a href="-diff/index.html">Diff</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/DiffUtils.kt#L209">source</a>)</span></span></div><p class="paragraph">Applies <a href="apply-diff.html">diff</a> to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">this</a></p><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">source<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="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">strictComparison<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-diff/index.html">Diff</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/DiffUtils.kt#L227">source</a>)</span></span></div><p class="paragraph">This method call <a href="calculate-diff.html">calculateDiff</a> with strict mode <a href="apply-diff.html">strictComparison</a> and then apply differences to <span data-unresolved-link="dev.inmo.micro_utils.common//&amp;lt;this&amp;gt;/#/PointingToCallableParameters(-1)/">this</span> mutable list</p><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">source<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="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">comparisonFun<span class="token operator">: </span><span class="token punctuation">(</span><a href="apply-diff.html">T</a><span class="token operator">?</span><span class="token punctuation">, </span><a href="apply-diff.html">T</a><span class="token operator">?</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-diff/index.html">Diff</a><span class="token operator">&lt;</span><a href="apply-diff.html">T</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/DiffUtils.kt#L238">source</a>)</span></span></div><p class="paragraph">This method call <a href="calculate-diff.html">calculateDiff</a> and then apply differences to <span data-unresolved-link="dev.inmo.micro_utils.common//&amp;lt;this&amp;gt;/#/PointingToCallableParameters(-1)/">this</span> mutable list</p><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">MutableMap</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">mapDiff<span class="token operator">: </span><a href="-map-diff/index.html">MapDiff</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/MapDiff.kt#L81">source</a>)</span></span></div><p class="paragraph">Will apply <a href="apply-diff.html">mapDiff</a> to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">this</a></p><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">MutableMap</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">from<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">compareFun<span class="token operator">: </span><span class="token punctuation">(</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-map-diff/index.html">MapDiff</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/MapDiff.kt#L102">source</a>)</span></span></div><p class="paragraph">Will apply changes with <a href="apply-diff.html">from</a> map into <span data-unresolved-link="dev.inmo.micro_utils.common//&amp;lt;this&amp;gt;/#/PointingToCallableParameters(-1)/">this</span> one</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><a href="-map-diff/index.html">MapDiff</a> applied to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">this</a></p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>compare</span><wbr></wbr><span><span>Fun</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to determine changed values</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">MutableMap</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="apply-diff.html"><span class="token function">applyDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">from<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">strictComparison<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-map-diff/index.html">MapDiff</a><span class="token operator">&lt;</span><a href="apply-diff.html">K</a><span class="token punctuation">, </span><a href="apply-diff.html">V</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//common/src/commonMain/kotlin/dev/inmo/micro_utils/common/MapDiff.kt#L119">source</a>)</span></span></div><p class="paragraph">Will apply changes with <a href="apply-diff.html">from</a> map into <span data-unresolved-link="dev.inmo.micro_utils.common//&amp;lt;this&amp;gt;/#/PointingToCallableParameters(-1)/">this</span> one</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><a href="-map-diff/index.html">MapDiff</a> applied to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html">this</a></p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>strict</span><wbr></wbr><span><span>Comparison</span></span></u></div></span></div><div><div class="title"><p class="paragraph">If true, will use strict (===) comparison for the values' comparison. Otherwise, standard <code class="lang-kotlin">equals</code> will be used</p></div></div></div></div></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>