ProtoOutputStream

ProtoOutputStream

ProtoOutputStream()

Construct a ProtoOutputStream with the default chunk size.

This is for an in-memory proto. The caller should use getBytes() for the result.

ProtoOutputStream

ProtoOutputStream(stream: OutputStream)

Construct a ProtoOutputStream that sits on top of an OutputStream.

The flush() method must be called when done writing to flush any remaining data, although data *may* be written at intermediate points within the writing as well.

checkFieldId

static fun checkFieldId(
    fieldId: Long, 
    expectedFlags: Long
): Int

Validates that the fieldId provided is of the type and count from expectedType.

The type must match exactly to pass this check.

The count must match according to this truth table to pass the check: expectedFlags UNKNOWN SINGLE REPEATED PACKED fieldId UNKNOWN true false false false SINGLE x true false false REPEATED x false true false PACKED x false true true

dump

fun dump(tag: String): Unit

Dump debugging data about the buffers with the given log tag.

end

fun end(token: Long): Unit

End the object started by start() that returned token.

flush

fun flush(): Unit

Write remaining data to the output stream. If there is no output stream, this function does nothing. Any currently open objects (i.e. ones that have not had end(long) called for them will not be written). Whether this writes objects that are closed if there are remaining open objects is undefined (current implementation does not write it, future ones will). For now, can either call getBytes() or flush(), but not both.

getBytes

fun getBytes(): ByteArray

Finish the encoding of the data, and return a byte[] with the protobuf formatted data.

After this call, do not call any of the write* functions. The behavior is undefined.

getFieldCountString

static fun getFieldCountString(fieldCount: Long): String?

Get the developer-usable name of a field count.

getFieldIdString

static fun getFieldIdString(fieldId: Long): String

Get a debug string for a fieldId.

getFieldTypeString

static fun getFieldTypeString(fieldType: Long): String?

Get the developer-usable name of a field type.

getRawSize

fun getRawSize(): Int

Returns the total size of the data that has been written, after full protobuf encoding has occurred.

getWireTypeString

static fun getWireTypeString(wireType: Int): String?

Get the developer-usable name of a wire type.

makeFieldId

static fun makeFieldId(
    id: Int, 
    fieldFlags: Long
): Long

Combine a fieldId (the field keys in the proto file) and the field flags. Mostly useful for testing because the generated code contains the fieldId constants.

makeToken

static fun makeToken(
    tagSize: Int, 
    repeated: Boolean, 
    depth: Int, 
    objectId: Int, 
    offset: Int
): Long

Make a token. Bits 61-63 - tag size (So we can go backwards later if the object had not data) - 3 bits, max value 7, max value needed 5 Bit 60 - true if the object is repeated (lets us require endObject or endRepeatedObject) Bits 59-51 - depth (For error checking) - 9 bits, max value 512, when checking, value is masked (if we really are more than 512 levels deep) Bits 32-50 - objectId (For error checking) - 19 bits, max value 524,288. that's a lot of objects. IDs will wrap because of the overflow, and only the tokens are compared. Bits 0-31 - offset of interest for the object.

start

fun start(fieldId: Long): Long

Start a sub object.

token2String

static fun token2String(token: Long): String

Return a debugging string of a token.

write

fun write(
    fieldId: Long, 
    val: Boolean
): Unit

Write a boolean value for the given fieldId.

If the field is not a bool field, an IllegalStateException will be thrown.

write

fun write(
    fieldId: Long, 
    val: ByteArray?
): Unit

Write a byte[] value for the given fieldId.

If the field is not a bytes or object field, an exception will be thrown.

write

fun write(
    fieldId: Long, 
    val: Double
): Unit

Write a value for the given fieldId.

Will automatically convert for the following field types, and throw an exception for others: double, float, int32, int64, uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.

write

fun write(
    fieldId: Long, 
    val: Float
): Unit

Write a value for the given fieldId.

Will automatically convert for the following field types, and throw an exception for others: double, float, int32, int64, uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.

write

fun write(
    fieldId: Long, 
    val: Int
): Unit

Write a value for the given fieldId.

Will automatically convert for the following field types, and throw an exception for others: double, float, int32, int64, uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.

write

fun write(
    fieldId: Long, 
    val: String?
): Unit

Write a string value for the given fieldId.

If the field is not a string field, an exception will be thrown.

write

fun write(
    fieldId: Long, 
    val: Long
): Unit

Write a value for the given fieldId.

Will automatically convert for the following field types, and throw an exception for others: double, float, int32, int64, uint32, uint64, sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.

writeTag

fun writeTag(
    id: Int, 
    wireType: Int
): Unit

Write an individual field tag by hand. See Protobuf Encoding for details on the structure of how tags and data are written.