#import <GPBCodedOutputStream.h>

Inheritance diagram for GPBCodedOutputStream:

Instance Methods
(void)	- flush

(instancetype)	- initWithData:

(instancetype)	- initWithOutputStream:

(void)	- writeBool:value:

(void)	- writeBoolArray:values:tag:

(void)	- writeBoolNoTag:

(void)	- writeBytes:value:

(void)	- writeBytesArray:values:

(void)	- writeBytesNoTag:

(void)	- writeDouble:value:

(void)	- writeDoubleArray:values:tag:

(void)	- writeDoubleNoTag:

(void)	- writeEnum:value:

(void)	- writeEnumArray:values:tag:

(void)	- writeEnumNoTag:

(void)	- writeFixed32:value:

(void)	- writeFixed32Array:values:tag:

(void)	- writeFixed32NoTag:

(void)	- writeFixed64:value:

(void)	- writeFixed64Array:values:tag:

(void)	- writeFixed64NoTag:

(void)	- writeFloat:value:

(void)	- writeFloatArray:values:tag:

(void)	- writeFloatNoTag:

(void)	- writeGroup:value:

(void)	- writeGroupArray:values:

(void)	- writeGroupNoTag:value:

(void)	- writeInt32:value:

(void)	- writeInt32Array:values:tag:

(void)	- writeInt32NoTag:

(void)	- writeInt64:value:

(void)	- writeInt64Array:values:tag:

(void)	- writeInt64NoTag:

(void)	- writeMessage:value:

(void)	- writeMessageArray:values:

(void)	- writeMessageNoTag:

(void)	- writeMessageSetExtension:value:

(void)	- writeRawByte:

(void)	- writeRawData:

(void)	- writeRawLittleEndian32:

(void)	- writeRawLittleEndian64:

(void)	- writeRawMessageSetExtension:value:

(void)	- writeRawPtr:offset:length:

(void)	- writeRawVarint32:

(void)	- writeRawVarint64:

(void)	- writeRawVarintSizeTAs32:

(void)	- writeSFixed32:value:

(void)	- writeSFixed32Array:values:tag:

(void)	- writeSFixed32NoTag:

(void)	- writeSFixed64:value:

(void)	- writeSFixed64Array:values:tag:

(void)	- writeSFixed64NoTag:

(void)	- writeSInt32:value:

(void)	- writeSInt32Array:values:tag:

(void)	- writeSInt32NoTag:

(void)	- writeSInt64:value:

(void)	- writeSInt64Array:values:tag:

(void)	- writeSInt64NoTag:

(void)	- writeString:value:

(void)	- writeStringArray:values:

(void)	- writeStringNoTag:

(void)	- writeTag:format:

(void)	- writeUInt32:value:

(void)	- writeUInt32Array:values:tag:

(void)	- writeUInt32NoTag:

(void)	- writeUInt64:value:

(void)	- writeUInt64Array:values:tag:

(void)	- writeUInt64NoTag:

(void)	- writeUnknownGroup:value:

(void)	- writeUnknownGroupArray:values:

(void)	- writeUnknownGroupNoTag:value:

Class Methods
(instancetype)	+ streamWithData:

(instancetype)	+ streamWithOutputStream:

Detailed Description

Writes out protocol message fields.

The common uses of protocol buffers shouldn't need to use this class. GPBMessage's provide a -data method that will serialize the message for you.

Note: Any -write* api can raise the GPBCodedOutputStreamException_* exceptions.; Subclassing of GPBCodedOutputStream is NOT supported.

Definition at line 66 of file GPBCodedOutputStream.h.

Method Documentation

◆ flush

- (void) flush

Flush any buffered data out.

◆ initWithData:

- (instancetype) initWithData: (NSMutableData *) data

Initializes a stream to fill in the given data. Data must be sized to fit or an error will be raised when out of space.

Parameters

data	The data where the stream will be written to.

Returns: A newly initialized GPBCodedOutputStream.

◆ initWithOutputStream:

- (instancetype) initWithOutputStream: (NSOutputStream *) output

Initializes a stream to write into the given NSOutputStream.

Parameters

output The output stream where the stream will be written to.

Returns: A newly initialized GPBCodedOutputStream.

◆ streamWithData:

+ (instancetype) streamWithData: (NSMutableData *) data

Creates a stream to fill in the given data. Data must be sized to fit or an error will be raised when out of space.

Parameters

data	The data where the stream will be written to.

Returns: A newly instanced GPBCodedOutputStream.

◆ streamWithOutputStream:

+ (instancetype) streamWithOutputStream: (NSOutputStream *) output

Creates a stream to write into the given NSOutputStream.

Parameters

output The output stream where the stream will be written to.

Returns: A newly instanced GPBCodedOutputStream.

◆ writeBool:value:

- (void) writeBool:	(int32_t)	fieldNumber
value:	(BOOL)	value

Write a BOOL for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeBoolArray:values:tag:

- (void) writeBoolArray:	(int32_t)	fieldNumber
values:	(GPBBoolArray *)	values
tag:	(uint32_t)	tag

Write a packed array of BOOL for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeBoolNoTag:

- (void) writeBoolNoTag: (BOOL) value

Write a BOOL without any tag.

Parameters

value The value to write out.

◆ writeBytes:value:

- (void) writeBytes:	(int32_t)	fieldNumber
value:	(NSData *)	value

Write a NSData for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeBytesArray:values:

- (void) writeBytesArray:	(int32_t)	fieldNumber
values:	(NSArray< NSData * > *)	values

Write an array of NSData for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.

◆ writeBytesNoTag:

- (void) writeBytesNoTag: (NSData *) value

Write a NSData without any tag.

Parameters

value The value to write out.

◆ writeDouble:value:

- (void) writeDouble:	(int32_t)	fieldNumber
value:	(double)	value

Write a double for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeDoubleArray:values:tag:

- (void) writeDoubleArray:	(int32_t)	fieldNumber
values:	(GPBDoubleArray *)	values
tag:	(uint32_t)	tag

Write a packed array of double for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeDoubleNoTag:

- (void) writeDoubleNoTag: (double) value

Write a double without any tag.

Parameters

value The value to write out.

◆ writeEnum:value:

- (void) writeEnum:	(int32_t)	fieldNumber
value:	(int32_t)	value

Write a int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeEnumArray:values:tag:

- (void) writeEnumArray:	(int32_t)	fieldNumber
values:	(GPBEnumArray *)	values
tag:	(uint32_t)	tag

Write a packed array of int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeEnumNoTag:

- (void) writeEnumNoTag: (int32_t) value

Write a int32_t without any tag.

Parameters

value The value to write out.

◆ writeFixed32:value:

- (void) writeFixed32:	(int32_t)	fieldNumber
value:	(uint32_t)	value

Write a uint32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeFixed32Array:values:tag:

- (void) writeFixed32Array:	(int32_t)	fieldNumber
values:	(GPBUInt32Array *)	values
tag:	(uint32_t)	tag

Write a packed array of uint32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeFixed32NoTag:

- (void) writeFixed32NoTag: (uint32_t) value

Write a uint32_t without any tag.

Parameters

value The value to write out.

◆ writeFixed64:value:

- (void) writeFixed64:	(int32_t)	fieldNumber
value:	(uint64_t)	value

Write a uint64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeFixed64Array:values:tag:

- (void) writeFixed64Array:	(int32_t)	fieldNumber
values:	(GPBUInt64Array *)	values
tag:	(uint32_t)	tag

Write a packed array of uint64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeFixed64NoTag:

- (void) writeFixed64NoTag: (uint64_t) value

Write a uint64_t without any tag.

Parameters

value The value to write out.

◆ writeFloat:value:

- (void) writeFloat:	(int32_t)	fieldNumber
value:	(float)	value

Write a float for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeFloatArray:values:tag:

- (void) writeFloatArray:	(int32_t)	fieldNumber
values:	(GPBFloatArray *)	values
tag:	(uint32_t)	tag

Write a packed array of float for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeFloatNoTag:

- (void) writeFloatNoTag: (float) value

Write a float without any tag.

Parameters

value The value to write out.

◆ writeGroup:value:

- (void) writeGroup:	(int32_t)	fieldNumber
value:	(GPBMessage *)	value

Write a GPBMessage for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeGroupArray:values:

- (void) writeGroupArray:	(int32_t)	fieldNumber
values:	(NSArray< GPBMessage * > *)	values

Write an array of GPBMessage for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.

◆ writeGroupNoTag:value:

- (void) writeGroupNoTag:	(int32_t)	fieldNumber
value:	(GPBMessage *)	value

Write a GPBMessage without any tag (but does write the endGroup tag).

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeInt32:value:

- (void) writeInt32:	(int32_t)	fieldNumber
value:	(int32_t)	value

Write a int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeInt32Array:values:tag:

- (void) writeInt32Array:	(int32_t)	fieldNumber
values:	(GPBInt32Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeInt32NoTag:

- (void) writeInt32NoTag: (int32_t) value

Write a int32_t without any tag.

Parameters

value The value to write out.

◆ writeInt64:value:

- (void) writeInt64:	(int32_t)	fieldNumber
value:	(int64_t)	value

Write a int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeInt64Array:values:tag:

- (void) writeInt64Array:	(int32_t)	fieldNumber
values:	(GPBInt64Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeInt64NoTag:

- (void) writeInt64NoTag: (int64_t) value

Write a int64_t without any tag.

Parameters

value The value to write out.

◆ writeMessage:value:

- (void) writeMessage:	(int32_t)	fieldNumber
value:	(GPBMessage *)	value

Write a GPBMessage for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeMessageArray:values:

- (void) writeMessageArray:	(int32_t)	fieldNumber
values:	(NSArray< GPBMessage * > *)	values

Write an array of GPBMessage for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.

◆ writeMessageNoTag:

- (void) writeMessageNoTag: (GPBMessage *) value

Write a GPBMessage without any tag.

Parameters

value The value to write out.

◆ writeMessageSetExtension:value:

- (void) writeMessageSetExtension:	(int32_t)	fieldNumber
value:	(GPBMessage *)	value

Write a MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Parameters

fieldNumber	The extension field number to write out.
value	The message from where to get the extension.

◆ writeRawByte:

- (void) writeRawByte: (uint8_t) value

Write the raw byte out.

Parameters

value The value to write out.

◆ writeRawData:

- (void) writeRawData: (NSData *) data

Writes the contents of an NSData out.

Parameters

data	The data to write out.

◆ writeRawLittleEndian32:

- (void) writeRawLittleEndian32: (int32_t) value

Write a 32bit value out in little endian format.

Parameters

value The value to write out.

◆ writeRawLittleEndian64:

- (void) writeRawLittleEndian64: (int64_t) value

Write a 64bit value out in little endian format.

Parameters

value The value to write out.

◆ writeRawMessageSetExtension:value:

- (void) writeRawMessageSetExtension:	(int32_t)	fieldNumber
value:	(NSData *)	value

Write an unparsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Parameters

fieldNumber	The extension field number to write out.
value	The raw message from where to get the extension.

◆ writeRawPtr:offset:length:

- (void) writeRawPtr:	(const void *)	data
offset:	(size_t)	offset
length:	(size_t)	length

Writes out the given data.

Parameters

data	The data blob to write out.
offset	The offset into the blob to start writing out.
length	The number of bytes from the blob to write out.

◆ writeRawVarint32:

- (void) writeRawVarint32: (int32_t) value

Write a 32bit value out in varint format.

Parameters

value The value to write out.

◆ writeRawVarint64:

- (void) writeRawVarint64: (int64_t) value

Write a 64bit value out in varint format.

Parameters

value The value to write out.

◆ writeRawVarintSizeTAs32:

- (void) writeRawVarintSizeTAs32: (size_t) value

Write a size_t out as a 32bit varint value.

Note: This will truncate 64 bit values to 32.

Parameters

value The value to write out.

◆ writeSFixed32:value:

- (void) writeSFixed32:	(int32_t)	fieldNumber
value:	(int32_t)	value

Write a int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeSFixed32Array:values:tag:

- (void) writeSFixed32Array:	(int32_t)	fieldNumber
values:	(GPBInt32Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeSFixed32NoTag:

- (void) writeSFixed32NoTag: (int32_t) value

Write a int32_t without any tag.

Parameters

value The value to write out.

◆ writeSFixed64:value:

- (void) writeSFixed64:	(int32_t)	fieldNumber
value:	(int64_t)	value

Write a int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeSFixed64Array:values:tag:

- (void) writeSFixed64Array:	(int32_t)	fieldNumber
values:	(GPBInt64Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeSFixed64NoTag:

- (void) writeSFixed64NoTag: (int64_t) value

Write a int64_t without any tag.

Parameters

value The value to write out.

◆ writeSInt32:value:

- (void) writeSInt32:	(int32_t)	fieldNumber
value:	(int32_t)	value

Write a int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeSInt32Array:values:tag:

- (void) writeSInt32Array:	(int32_t)	fieldNumber
values:	(GPBInt32Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeSInt32NoTag:

- (void) writeSInt32NoTag: (int32_t) value

Write a int32_t without any tag.

Parameters

value The value to write out.

◆ writeSInt64:value:

- (void) writeSInt64:	(int32_t)	fieldNumber
value:	(int64_t)	value

Write a int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeSInt64Array:values:tag:

- (void) writeSInt64Array:	(int32_t)	fieldNumber
values:	(GPBInt64Array *)	values
tag:	(uint32_t)	tag

Write a packed array of int64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeSInt64NoTag:

- (void) writeSInt64NoTag: (int64_t) value

Write a int64_t without any tag.

Parameters

value The value to write out.

◆ writeString:value:

- (void) writeString:	(int32_t)	fieldNumber
value:	(NSString *)	value

Write a NSString for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeStringArray:values:

- (void) writeStringArray:	(int32_t)	fieldNumber
values:	(NSArray< NSString * > *)	values

Write an array of NSString for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.

◆ writeStringNoTag:

- (void) writeStringNoTag: (NSString *) value

Write a NSString without any tag.

Parameters

value The value to write out.

◆ writeTag:format:

- (void) writeTag:	(uint32_t)	fieldNumber
format:	(GPBWireFormat)	format

Write the tag for the given field number and wire format.

Parameters

fieldNumber	The field number.
format	The wire format the data for the field will be in.

◆ writeUInt32:value:

- (void) writeUInt32:	(int32_t)	fieldNumber
value:	(uint32_t)	value

Write a uint32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeUInt32Array:values:tag:

- (void) writeUInt32Array:	(int32_t)	fieldNumber
values:	(GPBUInt32Array *)	values
tag:	(uint32_t)	tag

Write a packed array of uint32_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeUInt32NoTag:

- (void) writeUInt32NoTag: (uint32_t) value

Write a uint32_t without any tag.

Parameters

value The value to write out.

◆ writeUInt64:value:

- (void) writeUInt64:	(int32_t)	fieldNumber
value:	(uint64_t)	value

Write a uint64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeUInt64Array:values:tag:

- (void) writeUInt64Array:	(int32_t)	fieldNumber
values:	(GPBUInt64Array *)	values
tag:	(uint32_t)	tag

Write a packed array of uint64_t for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.
tag	The tag assigned to the values.

◆ writeUInt64NoTag:

- (void) writeUInt64NoTag: (uint64_t) value

Write a uint64_t without any tag.

Parameters

value The value to write out.

◆ writeUnknownGroup:value:

- (void) writeUnknownGroup:	(int32_t)	fieldNumber
value:	(GPBUnknownFieldSet *)	value

Write a GPBUnknownFieldSet for the given field number.

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

◆ writeUnknownGroupArray:values:

- (void) writeUnknownGroupArray:	(int32_t)	fieldNumber
values:	(NSArray< GPBUnknownFieldSet * > *)	values

Write an array of GPBUnknownFieldSet for the given field number.

Parameters

fieldNumber	The field number assigned to the values.
values	The values to write out.

◆ writeUnknownGroupNoTag:value:

- (void) writeUnknownGroupNoTag:	(int32_t)	fieldNumber
value:	(GPBUnknownFieldSet *)	value

Write a GPBUnknownFieldSet without any tag (but does write the endGroup tag).

Parameters

fieldNumber	The field number assigned to the value.
value	The value to write out.

The documentation for this class was generated from the following file:

GPBCodedOutputStream.h

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ flush

◆ initWithData:

◆ initWithOutputStream:

◆ streamWithData:

◆ streamWithOutputStream:

◆ writeBool:value:

◆ writeBoolArray:values:tag:

◆ writeBoolNoTag:

◆ writeBytes:value:

◆ writeBytesArray:values:

◆ writeBytesNoTag:

◆ writeDouble:value:

◆ writeDoubleArray:values:tag:

◆ writeDoubleNoTag:

◆ writeEnum:value:

◆ writeEnumArray:values:tag:

◆ writeEnumNoTag:

◆ writeFixed32:value:

◆ writeFixed32Array:values:tag:

◆ writeFixed32NoTag:

◆ writeFixed64:value:

◆ writeFixed64Array:values:tag:

◆ writeFixed64NoTag:

◆ writeFloat:value:

◆ writeFloatArray:values:tag:

◆ writeFloatNoTag:

◆ writeGroup:value:

◆ writeGroupArray:values:

◆ writeGroupNoTag:value:

◆ writeInt32:value:

◆ writeInt32Array:values:tag:

◆ writeInt32NoTag:

◆ writeInt64:value:

◆ writeInt64Array:values:tag:

◆ writeInt64NoTag:

◆ writeMessage:value:

◆ writeMessageArray:values:

◆ writeMessageNoTag:

◆ writeMessageSetExtension:value:

◆ writeRawByte:

◆ writeRawData:

◆ writeRawLittleEndian32:

◆ writeRawLittleEndian64:

◆ writeRawMessageSetExtension:value:

◆ writeRawPtr:offset:length:

◆ writeRawVarint32:

◆ writeRawVarint64:

◆ writeRawVarintSizeTAs32:

◆ writeSFixed32:value:

◆ writeSFixed32Array:values:tag:

◆ writeSFixed32NoTag:

◆ writeSFixed64:value:

◆ writeSFixed64Array:values:tag:

◆ writeSFixed64NoTag:

◆ writeSInt32:value:

◆ writeSInt32Array:values:tag:

◆ writeSInt32NoTag:

◆ writeSInt64:value:

◆ writeSInt64Array:values:tag:

◆ writeSInt64NoTag:

◆ writeString:value:

◆ writeStringArray:values:

◆ writeStringNoTag:

◆ writeTag:format:

◆ writeUInt32:value:

◆ writeUInt32Array:values:tag:

◆ writeUInt32NoTag:

◆ writeUInt64:value:

◆ writeUInt64Array:values:tag:

◆ writeUInt64NoTag:

◆ writeUnknownGroup:value:

◆ writeUnknownGroupArray:values:

◆ writeUnknownGroupNoTag:value: