Skip to content

Commit 9056f30

Browse files
recursive-rat4Pavel Vasin
andauthored
docs: Fix missing call to endStructure() (#2351)
Co-authored-by: Pavel Vasin <[email protected]>
1 parent ba7d17a commit 9056f30

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/value-classes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ in `serialize` method:
9898

9999
```kotlin
100100
override fun serialize(encoder: Encoder, value: NamedColor) {
101-
encoder.beginStructure(descriptor) {
101+
encoder.encodeStructure(descriptor) {
102102
encodeSerializableElement(descriptor, 0, Color.serializer(), value.color)
103103
encodeStringElement(descriptor, 1, value.name)
104104
}
@@ -113,7 +113,7 @@ unboxed value:
113113

114114
```kotlin
115115
override fun serialize(encoder: Encoder, value: NamedColor) {
116-
encoder.beginStructure(descriptor) {
116+
encoder.encodeStructure(descriptor) {
117117
encodeInlineElement(descriptor, 0).encodeInt(value.color)
118118
encodeStringElement(descriptor, 1, value.name)
119119
}
@@ -123,7 +123,7 @@ override fun serialize(encoder: Encoder, value: NamedColor) {
123123
The same principle goes also with [CompositeDecoder]: it has [decodeInlineElement][CompositeDecoder.decodeInlineElement] function that returns [Decoder].
124124

125125
If your class should be represented as a primitive (as shown in [Primitive serializer](serializers.md#primitive-serializer) section),
126-
and you cannot use [beginStructure][Encoder.beginStructure] function, there is a complementary function in [Encoder] called [encodeInline][Encoder.encodeInline].
126+
and you cannot use [encodeStructure][Encoder.encodeStructure] function, there is a complementary function in [Encoder] called [encodeInline][Encoder.encodeInline].
127127
We will use it to show an example how one can represent a class as an unsigned integer.
128128

129129
Let's start with a UID class:
@@ -187,7 +187,7 @@ override fun deserialize(decoder: Decoder): UID {
187187
[CompositeDecoder]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-composite-decoder/index.html
188188
[CompositeDecoder.decodeInlineElement]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-composite-decoder/decode-inline-element.html
189189
[Decoder]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-decoder/index.html
190-
[Encoder.beginStructure]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-encoder/begin-structure.html
190+
[Encoder.encodeStructure]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/encode-structure.html
191191
[Encoder.encodeInline]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-encoder/encode-inline.html
192192
[Encoder.encodeInt]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-core/kotlinx.serialization.encoding/-encoder/encode-int.html
193193

0 commit comments

Comments
 (0)