ksrpc-core/com.monkopedia.ksrpc/MethodMetadata

MethodMetadata

data class MethodMetadata(val annotationFqName: String, val arguments: List<Pair<String, MetadataValue>>)

A captured sibling annotation on a @KsMethod function.

The ksrpc compiler plugin walks every annotation on a @KsMethod function whose annotation class is itself annotated with com.monkopedia.ksrpc.annotation.KsMethodMetadata, decodes its arguments into MetadataValues, and attaches a MethodMetadata entry to the generated RpcMethod. Transport layers can then look the metadata up by annotationFqName when serializing a call.

The container is intentionally generic — older ksrpc versions reading a descriptor produced by a newer version see unfamiliar metadata entries as opaque MethodMetadata objects rather than failing. Consumers that don't know the annotation can ignore it; consumers that do know it can decode the arguments by name.

Constructors

MethodMetadata

constructor(annotationFqName: String, arguments: List<Pair<String, MetadataValue>>)

Properties

annotationFqName

val annotationFqName: String

the fully qualified name of the captured annotation class, e.g. com.example.MyMarker.

arguments

val arguments: List<Pair<String, MetadataValue>>

the captured annotation arguments, in declaration order, each as a name → MetadataValue pair. Default-valued arguments that the call site does not specify are not represented.

Functions

argument

fun argument(name: String): MetadataValue?

Look up the value of the argument with name, or null if no such argument was captured.

toString

open override fun toString(): String