Does this work with KMP? #245
Answered
by
orchestr7
realityexpander
asked this question in
Q&A
-
|
Quick question: Can I use this library with KMP? The moment I add the dependency in commonMain for ktoml, i get the following error: Here's the error: |
Beta Was this translation helpful? Give feedback.
Answered by
orchestr7
Nov 28, 2023
Replies: 1 comment 5 replies
-
|
Hey there! That's a great question 😄 The As mentioned in the readme: You can read the file on your platform and then use the library directly with your string or sequence of strings: // Add extensions from 'kotlinx' lib to your project:
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.serializer
// Add com.akuleshov7:ktoml-core to your project:
import com.akuleshov7.ktoml.deserialize
@Serializable
data class MyClass(/* your fields */)
// To deserialize TOML input in string format (separated by newlines '\n')
// No need to provide serializer() explicitly if you use the extension method from
// <kotlinx.serialization.decodeFromString>
val resultFromString = Toml.decodeFromString<MyClass>(/* string with a TOML input */)
val resultFromList = Toml.decodeFromString<MyClass>(serializer(), /* sequence with lines of strings with a TOML input */) |
Beta Was this translation helpful? Give feedback.
5 replies
-
|
@realityexpander feel free to reach out if you have any more questions! And please mark the post above as an answer if there is no more questions and it helped you 😄 |
Beta Was this translation helpful? Give feedback.
-
|
Ah, so you are using the Toml library on the raw strings instead of attempting to open the files. I found a different way to achieve the same result, and it turns out I didnt need TOML files after all, and thanks for the quick response! And plans of making it more painless for KMP users in the future? |
Beta Was this translation helpful? Give feedback.
-
|
@realityexpander, Ktoml utilizes an API from Kotlinx Serialization, which can be found at https://github.com/Kotlin/kotlinx.serialization. The anticipated structure for implementations involves having only a decodeFromString(string) method, consistent with other Kotlin serializers. Given our status as a multiplatform library, considerations must be made for various targets. Implementing native features unrelated to serialization, such as file reading (typically handled by separate libraries), can pose challenges. For instance, in KotlinJS, file reading is inherently not feasible. Nevertheless, in ktoml, we've chosen to expand this functionality for platforms where we comprehend the workings of the target code. While the iOSSimulator is somewhat unfamiliar to me as a backend developer, your request marks the second instance of such interest. Consequently, I am inclined to prioritize this implementation. Alternatively, you're welcome to contribute the implementation for this target in ktoml-file 😄 The process is relatively straightforward, requiring just two files similar to the JVM implementation 🙏 |
Beta Was this translation helpful? Give feedback.
Answer selected by
realityexpander
-
|
@realityexpander hm, actually looks like I was wrong - I have checked for an implementation and it looks like we already have an implementation for IosSimulatorArm64. Which Kotlin do you use? Can you give more info about the libraries? May be there is a reproducer project somewhere? |
Beta Was this translation helpful? Give feedback.
-
|
Yes I have a project that I simply tried to add your library to the commonMain and then attempted a build I did no further investigation until I asked this question. Https://GitHub.com/realityexpander/fredshistorymarkers is the project. I am attempting to create a POC app that is pure kotlin using KMP for both iOS and Android and avoiding android idioms as much as possible, like viewmodels and extensive ping ponging. |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@realityexpander, Ktoml utilizes an API from Kotlinx Serialization, which can be found at https://github.com/Kotlin/kotlinx.serialization. The anticipated structure for implementations involves having only a decodeFromString(string) method, consistent with other Kotlin serializers.
Given our status as a multiplatform library, considerations must be made for various targets. Implementing native features unrelated to serialization, such as file reading (typically handled by separate libraries), can pose challenges. For instance, in KotlinJS, file reading is inherently not feasible.
Nevertheless, in ktoml, we've chosen to expand this functionality for platforms where we comprehend the workin…