Skip to content

Clarify example for SerializationException #2806

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Clarify example for SerializationException #2806

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e575f9
Clarify example for SerializationException
sandwwraith Sep 2, 2024
72e4837
~exception abbr
sandwwraith Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions core/commonMain/src/kotlinx/serialization/SerializationExceptions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@ import kotlinx.serialization.descriptors.*
* It is also an established pattern to validate input in user's classes in the following manner:
* ```
* @Serializable
* class Foo(...) {
* class User(val age: Int, val name: String) {
* init {
* required(age > 0) { ... }
* require(age > 0) { ... }
* require(name.isNotBlank()) { ... }
* }
* }
*
* Json.decodeFromString<User>("""{"age": -100, "name": ""}""") // throws IllegalArgumentException from require()
* ```
* While clearly being serialization error (when compromised data was deserialized),
* Kotlin way is to throw `IllegalArgumentException` here instead of using library-specific `SerializationException`.
Expand Down