commonMain.com.microsoft.thrifty.Struct.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of thrifty-runtime-jvm Show documentation

Provides a minimal Thrift runtime to support classes generated by Thrifty

The newest version!

/*
 * Thrifty
 *
 * Copyright (c) Microsoft Corporation
 *
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * THIS CODE IS PROVIDED ON AN  *AS IS* BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 * WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
 * FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 *
 * See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 */
package com.microsoft.thrifty

import com.microsoft.thrifty.protocol.Protocol
import okio.IOException

/**
 * An interface that Thrift struct objects should implement.
 */
interface Struct {
    /**
     * Writes this [Struct] instance to the given `protocol`.
     *
     * @param protocol the protocol to which to write the struct
     * @throws IOException if writing fails
     */
    @Throws(IOException::class)
    fun write(protocol: Protocol)
}