software.amazon.smithy.kotlin.codegen.rendering.serde.StructuredDataSerializerGenerator.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package software.amazon.smithy.kotlin.codegen.rendering.serde

import software.amazon.smithy.codegen.core.Symbol
import software.amazon.smithy.kotlin.codegen.rendering.protocol.ProtocolGenerator
import software.amazon.smithy.model.shapes.MemberShape
import software.amazon.smithy.model.shapes.OperationShape
import software.amazon.smithy.model.shapes.Shape

/**
 * Responsible for rendering serialization of structured data (e.g. json, yaml, xml).
 */
interface StructuredDataSerializerGenerator {

    /**
     * Render function responsible for serializing members bound to the payload of the given operation's input shape.
     *
     * ```
     * fun serializeFooOperationBody(context: ExecutionContext, input: Foo): ByteArray {
     *  ...
     * }
     * ```
     *
     * Implementations are expected to serialize to the specific data format and return the contents as a byte array.
     *
     * @param ctx the protocol generator context
     * @param op the operation to render serialize for
     * @param members the members of the operation's input shape that are bound to the payload. Not all members are
     * bound to the document, some may be bound to e.g. headers, uri, etc.
     * @return the generated symbol which should be a function matching the expected signature
     */
    fun operationSerializer(ctx: ProtocolGenerator.GenerationContext, op: OperationShape, members: List): Symbol

    /**
     * Render function responsible for serializing the given member shape as the payload.
     *
     * ```
     * fun serializeFooPayload(input: Foo): ByteArray {
     *  ...
     * }
     * ```
     *
     * Implementations are expected to serialize to the specific data format and return the contents as a byte array.
     *
     * @param ctx the protocol generator context
     * @param shape the shape or member to serialize
     * @param members the subset of members to serialize in the payload
     * @return the generated symbol which should be a function matching the expected signature
     */
    fun payloadSerializer(
        ctx: ProtocolGenerator.GenerationContext,
        shape: Shape,
        members: Collection? = null,
    ): Symbol
}