MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.serialization.mapper/-mapper-serializer/index.html
2023-04-19 14:31:52 +00:00

195 lines
26 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>MapperSerializer</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</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="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/jetbrains-mono.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">
<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="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../../index.html">
<span>micro_utils.dokka</span>
</a>
</div>
<div>
0.17.8 </div>
<div class="pull-right d-flex">
<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>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.serialization.mapper/MapperSerializer///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.serialization.mapper</a><span class="delimiter">/</span><span class="current">MapperSerializer</span></div>
<div class="cover ">
<h1 class="cover"><span>Mapper</span><wbr></wbr><span><span>Serializer</span></span></h1>
<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">open </span><span class="token keyword">class </span><a href="index.html">MapperSerializer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">base<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">serialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">O</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span></span><span class="parameter ">deserialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">O</a></span></span><span class="token punctuation">)</span> : <span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator">&gt; </span></div><p class="paragraph">Use this serializer when you have serializable type <a href="index.html">I</a> and want to map it to some <a href="index.html">O</a> in process of serialization/deserialization</p><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><span>base</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Serializer for <a href="index.html">I</a></p></div></div></div></div><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><span>serialize</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used in <a href="serialize.html">serialize</a> method to convert incoming <a href="index.html">O</a> to <a href="index.html">I</a> and serialize with <span data-unresolved-link="dev.inmo.micro_utils.serialization.mapper/MapperSerializer/base/#/PointingToDeclaration/">base</span></p></div></div></div></div><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><span>deserialize</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used in <a href="deserialize.html">deserialize</a> method to convert deserialized by <a href="index.html">base</a> to <a href="index.html">O</a></p></div></div></div></div></div></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members &amp; Extensions</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="-1516478510%2FConstructors%2F-1478683138" anchor-label="MapperSerializer" id="-1516478510%2FConstructors%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" 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><a href="-mapper-serializer.html"><span>Mapper</span><wbr></wbr><span><span>Serializer</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1516478510%2FConstructors%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">base<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">serialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">O</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">, </span></span><span class="parameter ">deserialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html">O</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-45869262%2FFunctions%2F-1478683138" anchor-label="deserialize" id="-45869262%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<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><a href="deserialize.html"><span><span>deserialize</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-45869262%2FFunctions%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deserialize.html"><span class="token function">deserialize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">decoder<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.encoding/Decoder///PointingToDeclaration/">Decoder</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">O</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1251216560%2FFunctions%2F-1478683138" anchor-label="mapDeserialization" id="1251216560%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="../map-deserialization.html"><span>map</span><wbr></wbr><span><span>Deserialization</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1251216560%2FFunctions%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-deserialization.html">I</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-deserialization.html">O</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/">DeserializationStrategy</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-deserialization.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../map-deserialization.html"><span class="token function">mapDeserialization</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>deserialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../map-deserialization.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../map-deserialization.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-mapper-deserialization-strategy/index.html">MapperDeserializationStrategy</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-deserialization.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-deserialization.html">O</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Will create <a href="../-mapper-deserialization-strategy/index.html">MapperDeserializationStrategy</a> to allow you to map <a href="../map-deserialization.html">I</a> to <a href="../map-deserialization.html">O</a> using <a href="../map-deserialization.html">deserialize</a> lambda during deserialization process</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1383314001%2FFunctions%2F-1478683138" anchor-label="mapFullSerialization" id="-1383314001%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="../map-full-serialization.html"><span>map</span><wbr></wbr><span>Full</span><wbr></wbr><span><span>Serialization</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1383314001%2FFunctions%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-full-serialization.html">I</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-full-serialization.html">O</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.serialization/KSerializer///PointingToDeclaration/">KSerializer</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-full-serialization.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../map-full-serialization.html"><span class="token function">mapFullSerialization</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>serialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../map-full-serialization.html">O</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../map-full-serialization.html">I</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>deserialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../map-full-serialization.html">I</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../map-full-serialization.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">MapperSerializer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-full-serialization.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-full-serialization.html">O</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Will create <a href="index.html">MapperSerializer</a> to allow you to map <a href="../map-full-serialization.html">O</a> to <a href="../map-full-serialization.html">I</a> and vice verse using <a href="../map-full-serialization.html">serialize</a>/<a href="../map-full-serialization.html">deserialize</a> lambda during serialization/deserialization process</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="250657282%2FFunctions%2F-1478683138" anchor-label="mapSerialization" id="250657282%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" 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><a href="../map-serialization.html"><span>map</span><wbr></wbr><span><span>Serialization</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="250657282%2FFunctions%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-serialization.html">I</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-serialization.html">O</a><span class="token operator">&gt; </span><span data-unresolved-link="kotlinx.serialization/SerializationStrategy///PointingToDeclaration/">SerializationStrategy</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-serialization.html">I</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../map-serialization.html"><span class="token function">mapSerialization</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>serialize<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../map-serialization.html">O</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="../map-serialization.html">I</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-mapper-serialization-strategy/index.html">MapperSerializationStrategy</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../map-serialization.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../map-serialization.html">O</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Will create <a href="../-mapper-serialization-strategy/index.html">MapperSerializationStrategy</a> to allow you to map <a href="../map-serialization.html">O</a> to <a href="../map-serialization.html">I</a> using <a href="../map-serialization.html">serialize</a> lambda during serialization process</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1161426952%2FFunctions%2F-1478683138" anchor-label="serialize" id="-1161426952%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<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><a href="serialize.html"><span><span>serialize</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1161426952%2FFunctions%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="serialize.html"><span class="token function">serialize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">encoder<span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.encoding/Encoder///PointingToDeclaration/">Encoder</span><span class="token punctuation">, </span></span><span class="parameter ">value<span class="token operator">: </span><a href="index.html">O</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1565942820%2FProperties%2F-1478683138" anchor-label="descriptor" id="-1565942820%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<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><a href="descriptor.html"><span><span>descriptor</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1565942820%2FProperties%2F-1478683138"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<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">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="descriptor.html">descriptor</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.serialization.descriptors/SerialDescriptor///PointingToDeclaration/">SerialDescriptor</span></div></div></div>
</div>
</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>© 2023 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>
</body>
</html>