wire-runtime/com.squareup.wire/ProtoAdapter

ProtoAdapter

expect abstract class ProtoAdapter<E>(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax, identity: E? = null, sourceFile: String? = null)

Inheritors

EnumAdapter

actual abstract class ProtoAdapter<E>(fieldEncoding: FieldEncoding, val type: KClass<*>?, val typeUrl: String?, val syntax: Syntax, val identity: E?, val sourceFile: String?)

Inheritors

EnumAdapter

actual abstract class ProtoAdapter<E>(fieldEncoding: FieldEncoding, val type: KClass<*>?, val typeUrl: String?, val syntax: Syntax, val identity: E?, val sourceFile: String?)

Inheritors

EnumAdapter

UnsupportedTypeProtoAdapter

actual abstract class ProtoAdapter<E>(fieldEncoding: FieldEncoding, val type: KClass<*>?, val typeUrl: String?, val syntax: Syntax, val identity: E?, val sourceFile: String?)

Inheritors

EnumAdapter

Constructors

ProtoAdapter

expect constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax, identity: E? = null, sourceFile: String? = null)

actual constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax, identity: E?, sourceFile: String?)

constructor(fieldEncoding: FieldEncoding, type: Class<*>)

constructor(fieldEncoding: FieldEncoding, type: Class<*>, typeUrl: String?)

constructor(fieldEncoding: FieldEncoding, type: Class<*>, typeUrl: String?, syntax: Syntax)

constructor(fieldEncoding: FieldEncoding, type: Class<*>, typeUrl: String?, syntax: Syntax, identity: E?)

constructor(fieldEncoding: FieldEncoding, type: KClass<*>?)

constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?)

constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax)

constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax, identity: E?)

constructor(fieldEncoding: FieldEncoding, type: Class<*>, typeUrl: String?, syntax: Syntax, identity: E?, sourceFile: String?)

actual constructor(fieldEncoding: FieldEncoding, type: KClass<*>?, typeUrl: String?, syntax: Syntax, identity: E?, sourceFile: String?)

Types

Companion

expect object Companion

actual object Companion

EnumConstantNotFoundException

expect class EnumConstantNotFoundException(value: Int, type: KClass<*>?) : IllegalArgumentException

actual class EnumConstantNotFoundException(val value: Int, type: KClass<*>?) : IllegalArgumentException

Properties

identity

expect val identity: E?

A special value that is used when a field is absent from an encoded proto3 message. When encoding a proto3 message, fields that hold this value will be omitted.

actual val identity: E?

sourceFile

expect val sourceFile: String?

Path to the file containing the protobuf definition of this type.

actual val sourceFile: String?

syntax

expect val syntax: Syntax

Identifies the syntax in which type is defined in the proto schema. This string contains either "proto2" or "proto3".

actual val syntax: Syntax

type

expect val type: KClass<*>?

actual val type: KClass<*>?

typeUrl

expect val typeUrl: String?

Identifies this type for inclusion in a google.protobuf.Any. This is a string like "type.googleapis.com/packagename.messagename" or null if this type is either not a message (such as scalars and enums), or was code-generated before Wire 3.2 which introduced support for type URLS.

actual val typeUrl: String?

Functions

asPacked

expect fun asPacked(): ProtoAdapter<List<E>>

Returns an adapter for E but as a packed, repeated value.

actual fun asPacked(): ProtoAdapter<List<E>>

Returns an adapter for E but as a packed, repeated value.

actual fun asPacked(): ProtoAdapter<List<E>>

Returns an adapter for E but as a packed, repeated value.

asRepeated

expect fun asRepeated(): ProtoAdapter<List<E>>

Returns an adapter for E but as a repeated value.

actual fun asRepeated(): ProtoAdapter<List<E>>

Returns an adapter for E but as a repeated value.

actual fun asRepeated(): ProtoAdapter<List<E>>

Returns an adapter for E but as a repeated value.

decode

expect abstract fun decode(reader: ProtoReader): E

Read a non-null value from reader.

expect fun decode(bytes: ByteArray): E

expect fun decode(bytes: ByteString): E

Read an encoded message from bytes.

expect fun decode(source: BufferedSource): E

Read an encoded message from source.

actual abstract fun decode(reader: ProtoReader): E

Read a non-null value from reader.

actual fun decode(bytes: ByteArray): E

actual fun decode(bytes: ByteString): E

Read an encoded message from bytes.

actual fun decode(source: BufferedSource): E

Read an encoded message from source.

actual abstract fun decode(reader: ProtoReader): E

fun decode(stream: InputStream): E

actual fun decode(bytes: ByteArray): E

actual fun decode(source: BufferedSource): E

actual fun decode(bytes: ByteString): E

actual abstract fun decode(reader: ProtoReader): E

Read a non-null value from reader.

actual fun decode(bytes: ByteArray): E

actual fun decode(bytes: ByteString): E

Read an encoded message from bytes.

actual fun decode(source: BufferedSource): E

Read an encoded message from source.

decode

@ExperimentalUnsignedTypes

fun <E> ProtoAdapter<E>.decode(data: <Error class: unknown class>): E

Read an encoded message from data.

encode

expect fun encode(value: E): ByteArray

Encode value as a byte[].

expect abstract fun encode(writer: ProtoWriter, value: E)

expect open fun encode(writer: ReverseProtoWriter, value: E)

Write non-null value to writer.

expect fun encode(sink: BufferedSink, value: E)

Encode value and write it to stream.

actual fun encode(value: E): ByteArray

Encode value as a byte[].

actual abstract fun encode(writer: ProtoWriter, value: E)

actual open fun encode(writer: ReverseProtoWriter, value: E)

Write non-null value to writer.

actual fun encode(sink: BufferedSink, value: E)

Encode value and write it to stream.

actual fun encode(value: E): ByteArray

actual abstract fun encode(writer: ProtoWriter, value: E)

actual open fun encode(writer: ReverseProtoWriter, value: E)

fun encode(stream: OutputStream, value: E)

actual fun encode(sink: BufferedSink, value: E)

actual fun encode(value: E): ByteArray

Encode value as a byte[].

actual abstract fun encode(writer: ProtoWriter, value: E)

actual open fun encode(writer: ReverseProtoWriter, value: E)

Write non-null value to writer.

actual fun encode(sink: BufferedSink, value: E)

Encode value and write it to stream.

encodeByteString

expect fun encodeByteString(value: E): ByteString

Encode value as a ByteString.

actual fun encodeByteString(value: E): ByteString

Encode value as a ByteString.

actual fun encodeByteString(value: E): ByteString

Encode value as a ByteString.

encodedSize

expect abstract fun encodedSize(value: E): Int

The size of the non-null data value. This does not include the size required for a length-delimited prefix (should the type require one).

actual abstract fun encodedSize(value: E): Int

The size of the non-null data value. This does not include the size required for a length-delimited prefix (should the type require one).

actual abstract fun encodedSize(value: E): Int

The size of the non-null data value. This does not include the size required for a length-delimited prefix (should the type require one).

encodedSizeWithTag

expect open fun encodedSizeWithTag(tag: Int, value: E?): Int

The size of tag and value in the wire format. This size includes the tag, type, length-delimited prefix (should the type require one), and value. Returns 0 if value is null.

actual open fun encodedSizeWithTag(tag: Int, value: E?): Int

The size of tag and value in the wire format. This size includes the tag, type, length-delimited prefix (should the type require one), and value. Returns 0 if value is null.

actual open fun encodedSizeWithTag(tag: Int, value: E?): Int

The size of tag and value in the wire format. This size includes the tag, type, length-delimited prefix (should the type require one), and value. Returns 0 if value is null.

encodeWithTag

expect open fun encodeWithTag(writer: ProtoWriter, tag: Int, value: E?)

expect open fun encodeWithTag(writer: ReverseProtoWriter, tag: Int, value: E?)

Write tag and value to writer. If value is null this does nothing.

actual open fun encodeWithTag(writer: ProtoWriter, tag: Int, value: E?)

actual open fun encodeWithTag(writer: ReverseProtoWriter, tag: Int, value: E?)

Write tag and value to writer. If value is null this does nothing.

actual open fun encodeWithTag(writer: ProtoWriter, tag: Int, value: E?)

actual open fun encodeWithTag(writer: ReverseProtoWriter, tag: Int, value: E?)

actual open fun encodeWithTag(writer: ProtoWriter, tag: Int, value: E?)

actual open fun encodeWithTag(writer: ReverseProtoWriter, tag: Int, value: E?)

Write tag and value to writer. If value is null this does nothing.

redact

expect abstract fun redact(value: E): E

Returns the redacted form of value.

actual abstract fun redact(value: E): E

Returns the redacted form of value.

actual abstract fun redact(value: E): E

Returns the redacted form of value.

toString

expect open fun toString(value: E): String

Returns a human-readable version of the given value.

actual open fun toString(value: E): String

Returns a human-readable version of the given value.

actual open fun toString(value: E): String

Returns a human-readable version of the given value.

tryDecode

expect fun tryDecode(reader: ProtoReader, destination: MutableList<E>)

Reads a value and appends it to destination if this has data available. Otherwise, it will only clear the reader state.

actual fun tryDecode(reader: ProtoReader, destination: MutableList<E>)