Class KotlinxSerializer

Namespace

TypedRest.CodeGeneration.Jvm

Assembly

TypedRest.CodeGeneration.Jvm.dll

Annotates DTOs for kotlinx.serialization.

public sealed class KotlinxSerializer : JvmSerializer

Inheritance

object

JvmSerializer

KotlinxSerializer

Inherited Members

JvmSerializer.Kotlinx

JvmSerializer.Jackson

JvmSerializer.Moshi

JvmSerializer.For(string)

Remarks

Requires the kotlin-serialization Gradle plugin in the consuming project.

Properties

Artifact

The Maven coordinates of the artifact providing RuntimeSerializer, for the generated README.

public override string Artifact { get; }

Property Value

string

Name

The name of this serializer.

public override string Name { get; }

Property Value

string

RuntimeSerializer

The runtime Serializer the entry endpoint has to be constructed with, or null if it is already the default of EntryEndpoint and can be left out.

public override JvmIdentifier? RuntimeSerializer { get; }

Property Value

JvmIdentifier

SupportsJava

Indicates whether this serializer can handle DTOs written in Java.

public override bool SupportsJava { get; }

Property Value

bool

Methods

EnumAnnotations()

Annotations that go on a generated enum.

public override IEnumerable<JvmAnnotation> EnumAnnotations()

Returns

IEnumerable<JvmAnnotation>

EnumMemberName(string)

The annotation carrying the wire name of an enum value, or null if the name needs none.

public override JvmAnnotation? EnumMemberName(string wireName)

Parameters

wireName string

Returns

JvmAnnotation

PropertyName(string)

The annotation carrying the wire name of a property, or null if the name needs none.

public override JvmAnnotation? PropertyName(string wireName)

Parameters

wireName string

Returns

JvmAnnotation

TypeAnnotations()

Annotations that go on a generated DTO class itself.

public override IEnumerable<JvmAnnotation> TypeAnnotations()

Returns

IEnumerable<JvmAnnotation>