commonMain.com.squareup.wire.Message.kt Maven / Gradle / Ivy
/*
* Copyright 2013 Square Inc.
*
* 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
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.squareup.wire
import okio.BufferedSink
import okio.ByteString
/** A protocol buffer message. */
expect abstract class Message, B : Message.Builder> protected constructor(
adapter: ProtoAdapter,
unknownFields: ByteString
) {
/** If non-zero, the hash code of this message. Accessed by generated code. */
protected var hashCode: Int
/**
* Returns a byte string containing the proto encoding of this message's unknown fields. Returns
* an empty byte string if this message has no unknown fields.
*/
val unknownFields: ByteString
/**
* Returns a new builder initialized with the data in this message.
*/
// TODO(egorand): Remove from common and not generate in Kotlin.
abstract fun newBuilder(): B
/** The [ProtoAdapter] for encoding and decoding messages of this type. */
val adapter: ProtoAdapter
/** Encode this message and write it to `stream`. */
fun encode(sink: BufferedSink)
/** Encode this message as a `byte[]`. */
fun encode(): ByteArray
/** Encode this message as a `ByteString`. */
fun encodeByteString(): ByteString
/**
* Superclass for protocol buffer message builders.
*/
abstract class Builder, B : Builder>
}