Class CodedInputStream (3.19.4)

Reads and decodes protocol message fields.

This class contains two kinds of methods: methods that read specific protocol message constructs and field types (e.g. #readTag() and #readInt32()) and methods that read low-level values (e.g. #readRawVarint32() and #readRawBytes). If you are reading encoded protocol messages, you should use the former methods, but if you are reading some other format of your own design, use the latter.

Decode a ZigZag-encoded 32-bit value. ZigZag encodes signed integers into values that can be efficiently encoded with varint. (Otherwise, negative values must be sign-extended to 64 bits to be varint encoded, thus always taking 10 bytes on the wire.)

Decode a ZigZag-encoded 64-bit value. ZigZag encodes signed integers into values that can be efficiently encoded with varint. (Otherwise, negative values must be sign-extended to 64 bits to be varint encoded, thus always taking 10 bytes on the wire.)

Create a new CodedInputStream wrapping the given byte array.

Create a new CodedInputStream wrapping the given byte array slice.

Create a new CodedInputStream wrapping the given InputStream.

Create a new CodedInputStream wrapping the given InputStream, with a specified buffer size.

Create a new CodedInputStream wrapping the given Iterable .

Create a new CodedInputStream wrapping the given ByteBuffer. The data starting from the ByteBuffer's current position to its limit will be read. The returned CodedInputStream may or may not share the underlying data in the ByteBuffer, therefore the ByteBuffer cannot be changed while the CodedInputStream is in use. Note that the ByteBuffer's position won't be changed by this function. Concurrent calls with the same ByteBuffer object are safe if no other thread is trying to alter the ByteBuffer's status.

Like #readRawVarint32(InputStream), but expects that the caller has already read one byte. This allows the caller to determine if EOF has been reached before attempting to read.

Read a group field value from the stream.

Read an embedded message field value from the stream.

Verifies that the last call to readTag() returned the given tag value. This is used to verify that a nested group ended with the correct end tag.

Enables ByteString aliasing of the underlying buffer, trading off on buffer pinning for data copies. Only valid for buffer-backed streams.

Returns the number of bytes to be read before the current limit. If no limit is set, returns -1.

The total bytes read up to the current position. Calling #resetSizeCounter() resets this value to zero.

Returns true if the stream has reached the end of the input. This is the case if either the end of the underlying input source has been reached or if the stream has reached a limit created using #pushLimit(int). This function may get blocked when using StreamDecoder as it invokes StreamDecoder#tryRefillBuffer(int) in this function which will try to read bytes from input.

Discards the current limit, returning to the previous limit.

Sets currentLimit to (current position) + byteLimit. This is called when descending into a length-delimited embedded message.

Note that pushLimit() does NOT affect how many bytes the CodedInputStream reads from an underlying InputStream when refreshing its buffer. If you need to prevent reading past a certain point in the underlying InputStream (e.g. because you expect it to contain more data after the end of the message which you need to handle differently) then you must place a wrapper around your InputStream which limits the amount of data that can be read from it.

Read a bool field value from the stream.

Read a bytes field value from the stream.

Read a bytes field value from the stream.

Read a bytes field value from the stream.

Read a double field value from the stream.

Read an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.

Read a fixed32 field value from the stream.

Read a fixed64 field value from the stream.

Read a float field value from the stream.

Read a group field value from the stream.

Read an int32 field value from the stream.

Read an int64 field value from the stream.

Read an embedded message field value from the stream.

Read one byte from the input.

Read a fixed size of bytes from the input.

Read a 32-bit little-endian integer from the stream.

Read a 64-bit little-endian integer from the stream.

Read a raw Varint from the stream. If larger than 32 bits, discard the upper bits.

Read a raw Varint from the stream.

Read an sfixed32 field value from the stream.

Read an sfixed64 field value from the stream.

Read an sint32 field value from the stream.

Read an sint64 field value from the stream.

Read a string field value from the stream. If the stream contains malformed UTF-8, replace the offending bytes with the standard UTF-8 replacement character.

Read a string field value from the stream. If the stream contains malformed UTF-8, throw exception InvalidProtocolBufferException.

Attempt to read a field tag, returning zero if we have reached EOF. Protocol message parsers use this to read tags, since a protocol message may legally end wherever a tag occurs, and zero is not a valid tag number.

Read a uint32 field value from the stream.

Read a uint64 field value from the stream.

Deprecated. UnknownFieldSet.Builder now implements MessageLite.Builder, so you can just call #readGroup.

Reads a group field value from the stream and merges it into the given UnknownFieldSet.

Resets the current size counter to zero (see #setSizeLimit(int)). Only valid for InputStream-backed streams.

Set the maximum message recursion depth. In order to prevent malicious messages from causing stack overflows, CodedInputStream limits how deeply messages may be nested. The default limit is 100.

Only valid for InputStream-backed streams.

Set the maximum message size. In order to prevent malicious messages from exhausting memory or causing integer overflows, CodedInputStream limits how large a message may be. The default limit is Integer.MAX_VALUE. You should set this limit as small as you can without harming your app's functionality. Note that size limits only apply when reading from an InputStream, not when constructed around a raw byte array.

If you want to read several messages from a single CodedInputStream, you could call #resetSizeCounter() after each one to avoid hitting the size limit.

Reads and discards a single field, given its tag value.

Deprecated. use UnknownFieldSet or UnknownFieldSetLite to skip to an output stream.

Reads a single field and writes it to output in wire format, given its tag value.

Reads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.

Reads an entire message and writes it to output in wire format. This will read either until EOF or until an endgroup tag, whichever comes first.

Reads and discards size bytes.