# R Interface to the 'Protocol Buffers' 'API' (Version 2 or 3)

## Documentation for package ‘RProtoBuf’ version 0.4.27

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Code demos. Use demo() to run them.
- Package NEWS.

## Help Pages

A B C D E F G H I L M N O P R S T U V W Z misc

RProtoBuf-package | R Interface to the Protocol Buffers API

## -- A --

add | add elements of a repeated field of a message
add-method | add elements of a repeated field of a message
add-methods | add elements of a repeated field of a message
all.equal-method | Class "Message"
ArrayInputStream | Creates an ArrayInputStream
ArrayInputStream-class | Class "ArrayInputStream"
ArrayInputStream-method | Creates an ArrayInputStream
ArrayInputStream-methods | Creates an ArrayInputStream
ArrayOutputStream | Creates an ArrayOutputStream
ArrayOutputStream-class | Class "ArrayOutputStream"
ArrayOutputStream-method | Creates an ArrayOutputStream
ArrayOutputStream-methods | Creates an ArrayOutputStream
as.character-method | Class "Descriptor"
as.character-method | Class "EnumDescriptor"
as.character-method | Class "EnumValueDescriptor"
as.character-method | Class "FieldDescriptor"
as.character-method | Class "FileDescriptor"
as.character-method | Class "Message"
as.character-method | Class "MethodDescriptor"
as.character-method | Class "ServiceDescriptor"
as.list.Descriptor | Grab the protocol buffer message as an R list
as.list.EnumDescriptor | Grab the protocol buffer message as an R list
as.list.FileDescriptor | Grab the protocol buffer message as an R list
as.list.Message | Grab the protocol buffer message as an R list
as.list.ServiceDescriptor | Grab the protocol buffer message as an R list
asMessage | coerce an object to a protobuf message

## -- B --

BackUp | Backs up a number of bytes from a stream
BackUp-method | Virtual Class "ZeroCopyInputStream"
BackUp-method | Virtual Class "ZeroCopyOutputStream"
BackUp-methods | Backs up a number of bytes from a stream
ByteCount | The number of bytes read/written since the object was created
ByteCount-method | Virtual Class "ZeroCopyInputStream"
ByteCount-method | Virtual Class "ZeroCopyOutputStream"
ByteCount-methods | The number of bytes read/written since the object was created
bytesize | The number of bytes taken by a message
bytesize-method | The number of bytes taken by a message
bytesize-methods | The number of bytes taken by a message

## -- C --

can_serialize_pb | Serialize R object to Protocol Buffer Message.
clear | Clear a field or all fields of the message and set them to their default values
clear-method | Clear a field or all fields of the message and set them to their default values
clear-methods | Clear a field or all fields of the message and set them to their default values
clone | Clone protocol buffer messages
clone-method | Clone protocol buffer messages
clone-methods | Clone protocol buffer messages
close-method | Class "FileInputStream"
close-method | Class "FileOutputStream"
ConnectionInputStream | Creates an ConnectionInputStream
ConnectionInputStream-class | Class "ConnectionInputStream"
ConnectionInputStream-method | Creates an ConnectionInputStream
ConnectionInputStream-methods | Creates an ConnectionInputStream
ConnectionOutputStream | Creates an ConnectionOutputStream
ConnectionOutputStream-class | Class "ConnectionOutputStream"
ConnectionOutputStream-method | Creates an ConnectionOutputStream
ConnectionOutputStream-methods | Creates an ConnectionOutputStream
containing_type | Gets the message type descriptor that contains a descriptor
containing_type-method | Class "Descriptor"
containing_type-method | Class "EnumDescriptor"
containing_type-method | Class "FieldDescriptor"
containing_type-methods | Gets the message type descriptor that contains a descriptor
CPPTYPE_BOOL | Gets the type or the C++ type of a field
CPPTYPE_DOUBLE | Gets the type or the C++ type of a field
CPPTYPE_ENUM | Gets the type or the C++ type of a field
CPPTYPE_FLOAT | Gets the type or the C++ type of a field
CPPTYPE_INT32 | Gets the type or the C++ type of a field
CPPTYPE_INT64 | Gets the type or the C++ type of a field
CPPTYPE_MESSAGE | Gets the type or the C++ type of a field
CPPTYPE_STRING | Gets the type or the C++ type of a field
CPPTYPE_UINT32 | Gets the type or the C++ type of a field
CPPTYPE_UINT64 | Gets the type or the C++ type of a field
cpp_type | Gets the type or the C++ type of a field
cpp_type-method | Class "FieldDescriptor"
cpp_type-methods | Gets the type or the C++ type of a field

## -- D --

default_value | Class "FieldDescriptor"
default_value-method | Class "FieldDescriptor"
default_value-methods | Class "FieldDescriptor"
descriptor | Get the descriptor of a message
Descriptor-class | Class "Descriptor"
descriptor-method | Get the descriptor of a message
descriptor-methods | Get the descriptor of a message

## -- E --

EnumDescriptor-class | Class "EnumDescriptor"
EnumValueDescriptor-class | Class "EnumValueDescriptor"
enum_type | Extract an enum type descriptor for a nested type
enum_type-method | Class "Descriptor"
enum_type-method | Class "EnumValueDescriptor"
enum_type-method | Class "FieldDescriptor"
enum_type-methods | Extract an enum type descriptor for a nested type
enum_type_count | The number of enum types
enum_type_count-method | Class "Descriptor"
enum_type_count-methods | The number of enum types

## -- F --

fetch | Fetch content of a repeated field
fetch-method | Fetch content of a repeated field
fetch-methods | Fetch content of a repeated field
field | Extract a field descriptor
field-method | Class "Descriptor"
field-methods | Extract a field descriptor
FieldDescriptor-class | Class "FieldDescriptor"
field_count | The number of fields
field_count-method | Class "Descriptor"
field_count-methods | The number of fields
fileDescriptor | gets the file descriptor of an object
FileDescriptor-class | Class "FileDescriptor"
fileDescriptor-method | gets the file descriptor of an object
fileDescriptor-methods | gets the file descriptor of an object
FileInputStream | Creates an FileInputStream
FileInputStream-class | Class "FileInputStream"
FileInputStream-method | Creates an FileInputStream
FileInputStream-methods | Creates an FileInputStream
FileOutputStream | Creates an FileOutputStream
FileOutputStream-class | Class "FileOutputStream"
FileOutputStream-method | Creates an FileOutputStream
FileOutputStream-methods | Creates an FileOutputStream
flush-method | Class "FileOutputStream"

## -- G --

GetErrno | Get the error number for an I/O error
GetErrno-method | Class "FileInputStream"
GetErrno-method | Class "FileOutputStream"
GetErrno-methods | Get the error number for an I/O error
getExtension | Class "Message"
getExtension-method | Class "Message"

## -- H --

has | Indicates if an object has the given field set
has-method | Class "EnumDescriptor"
has-method | Indicates if an object has the given field set
has-methods | Indicates if an object has the given field set
has_default_value | Class "FieldDescriptor"
has_default_value-method | Class "FieldDescriptor"
has_default_value-methods | Class "FieldDescriptor"

## -- I --

identical-method | Class "Message"
input_type | Class "MethodDescriptor"
input_type-method | Class "MethodDescriptor"
input_type-methods | Class "MethodDescriptor"
isInitialized | Indicates if a protocol buffer message is initialized
isInitialized-method | Indicates if a protocol buffer message is initialized
isInitialized-methods | Indicates if a protocol buffer message is initialized
is_extension | Indicates if a field descriptor is an extension
is_extension-method | Class "FieldDescriptor"
is_extension-methods | Indicates if a field descriptor is an extension
is_repeated | Class "FieldDescriptor"
is_repeated-method | Class "FieldDescriptor"
is_repeated-methods | Class "FieldDescriptor"
is_required | Class "FieldDescriptor"
is_required-method | Class "FieldDescriptor"
is_required-methods | Class "FieldDescriptor"

## -- L --

length-method | Class "Descriptor"
length-method | Class "EnumDescriptor"
length-method | Class "Message"
length-method | Class "ServiceDescriptor"

## -- M --

merge-method | Merge two messages of the same type
Message-class | Class "Message"
message_type | Class "FieldDescriptor"
message_type-method | Class "FieldDescriptor"
message_type-methods | Class "FieldDescriptor"
method | Class "ServiceDescriptor"
method-method | Class "ServiceDescriptor"
method-methods | Class "ServiceDescriptor"
MethodDescriptor-class | Class "MethodDescriptor"
method_count | Class "ServiceDescriptor"
method_count-method | Class "ServiceDescriptor"
method_count-methods | Class "ServiceDescriptor"

## -- N --

name | Name or full name of a descriptor
name-method | Class "EnumValueDescriptor"
name-method | Class "FileDescriptor"
name-method | Name or full name of a descriptor
name-methods | Name or full name of a descriptor
names-method | Class "Descriptor"
names-method | Class "EnumDescriptor"
names-method | Class "Message"
nested_type | Extract a message type descriptor for a nested type
nested_type-method | Class "Descriptor"
nested_type-methods | Extract a message type descriptor for a nested type
nested_type_count | The number of fields
nested_type_count-method | Class "Descriptor"
nested_type_count-methods | The number of fields
new-method | Class "Descriptor"
Next | Obtains a chunk of data from the stream
Next-method | Virtual Class "ZeroCopyInputStream"
Next-method | Virtual Class "ZeroCopyOutputStream"
Next-methods | Obtains a chunk of data from the stream
number | Gets the declared tag number of a field
number-method | Class "EnumValueDescriptor"
number-method | Class "FieldDescriptor"
number-methods | Gets the declared tag number of a field

## -- O --

output_type | Class "MethodDescriptor"
output_type-method | Class "MethodDescriptor"
output_type-methods | Class "MethodDescriptor"

## -- P --

P | Protocol Buffer descriptor importer

## -- R --

read | Read a protocol buffer message from a connection
read-method | Read a protocol buffer message from a connection
read-methods | Read a protocol buffer message from a connection
readASCII | read a message in ASCII format
readASCII-method | read a message in ASCII format
readASCII-methods | read a message in ASCII format
readJSON | read a message in JSON format
readJSON-method | read a message in JSON format
readJSON-methods | read a message in JSON format
ReadLittleEndian32 | Virtual Class "ZeroCopyInputStream"
ReadLittleEndian32-method | Virtual Class "ZeroCopyInputStream"
ReadLittleEndian32-methods | Virtual Class "ZeroCopyInputStream"
ReadLittleEndian64 | Virtual Class "ZeroCopyInputStream"
ReadLittleEndian64-method | Virtual Class "ZeroCopyInputStream"
ReadLittleEndian64-methods | Virtual Class "ZeroCopyInputStream"
readProtoFiles | protocol buffer descriptor importer
readProtoFiles2 | protocol buffer descriptor importer
ReadRaw | Virtual Class "ZeroCopyInputStream"
ReadRaw-method | Virtual Class "ZeroCopyInputStream"
ReadRaw-methods | Virtual Class "ZeroCopyInputStream"
ReadString | Virtual Class "ZeroCopyInputStream"
ReadString-method | Virtual Class "ZeroCopyInputStream"
ReadString-methods | Virtual Class "ZeroCopyInputStream"
ReadVarint32 | Virtual Class "ZeroCopyInputStream"
ReadVarint32-method | Virtual Class "ZeroCopyInputStream"
ReadVarint32-methods | Virtual Class "ZeroCopyInputStream"
ReadVarint64 | Virtual Class "ZeroCopyInputStream"
ReadVarint64-method | Virtual Class "ZeroCopyInputStream"
ReadVarint64-methods | Virtual Class "ZeroCopyInputStream"
resetDescriptorPool | protocol buffer descriptor importer
RProtoBuf | R Interface to the Protocol Buffers API

## -- S --

serialize-method | Class "Message"
serialize_pb | Serialize R object to Protocol Buffer Message.
ServiceDescriptor-class | Class "ServiceDescriptor"
set | set a subset of values of a repeated field of a message
set-method | set a subset of values of a repeated field of a message
set-methods | set a subset of values of a repeated field of a message
SetCloseOnDelete | set the close on delete behavior
SetCloseOnDelete-method | Class "FileInputStream"
SetCloseOnDelete-method | Class "FileOutputStream"
SetCloseOnDelete-methods | set the close on delete behavior
setExtension | Class "Message"
setExtension-method | Class "Message"
show-method | Class "Descriptor"
show-method | Class "EnumDescriptor"
show-method | Class "EnumValueDescriptor"
show-method | Class "FieldDescriptor"
show-method | Class "FileDescriptor"
show-method | Class "Message"
show-method | Class "ServiceDescriptor"
size | Size of a message field
size-method | Size of a message field
size-methods | Size of a message field
size<- | Set the size of a field
size<--method | Set the size of a field
size<--methods | Set the size of a field
Skip | Skips a number of bytes
Skip-method | Virtual Class "ZeroCopyInputStream"
Skip-methods | Skips a number of bytes
str-method | Class "Message"
swap | swap elements of a repeated field of a message
swap-method | swap elements of a repeated field of a message
swap-methods | swap elements of a repeated field of a message

## -- T --

toJSON | Class "Message"
toJSON-method | Class "Message"
toString-method | Class "Descriptor"
toString-method | Class "EnumDescriptor"
toString-method | Class "EnumValueDescriptor"
toString-method | Class "FieldDescriptor"
toString-method | Class "FileDescriptor"
toString-method | Class "Message"
toString-method | Class "MethodDescriptor"
toString-method | Class "ServiceDescriptor"
type | Gets the type or the C++ type of a field
type-method | Class "FieldDescriptor"
type-methods | Gets the type or the C++ type of a field
TYPE_BOOL | Gets the type or the C++ type of a field
TYPE_BYTES | Gets the type or the C++ type of a field
TYPE_DOUBLE | Gets the type or the C++ type of a field
TYPE_ENUM | Gets the type or the C++ type of a field
TYPE_FIXED32 | Gets the type or the C++ type of a field
TYPE_FIXED64 | Gets the type or the C++ type of a field
TYPE_FLOAT | Gets the type or the C++ type of a field
TYPE_GROUP | Gets the type or the C++ type of a field
TYPE_INT32 | Gets the type or the C++ type of a field
TYPE_INT64 | Gets the type or the C++ type of a field
TYPE_MESSAGE | Gets the type or the C++ type of a field
TYPE_SFIXED32 | Gets the type or the C++ type of a field
TYPE_SFIXED64 | Gets the type or the C++ type of a field
TYPE_SINT32 | Gets the type or the C++ type of a field
TYPE_SINT64 | Gets the type or the C++ type of a field
TYPE_STRING | Gets the type or the C++ type of a field
TYPE_UINT32 | Gets the type or the C++ type of a field
TYPE_UINT64 | Gets the type or the C++ type of a field

## -- U --

unserialize_pb | Serialize R object to Protocol Buffer Message.
update-method | Class "Message"

## -- V --

value | Class "EnumDescriptor"
value-method | Class "EnumDescriptor"
value-methods | Class "EnumDescriptor"
value_count | Class "EnumDescriptor"
value_count-method | Class "EnumDescriptor"
value_count-methods | Class "EnumDescriptor"

## -- W --

with.Message | with and within methods for protocol buffer messages
within.Message | with and within methods for protocol buffer messages
WriteLittleEndian32 | Virtual Class "ZeroCopyOutputStream"
WriteLittleEndian32-method | Virtual Class "ZeroCopyOutputStream"
WriteLittleEndian32-methods | Virtual Class "ZeroCopyOutputStream"
WriteLittleEndian64 | Virtual Class "ZeroCopyOutputStream"
WriteLittleEndian64-method | Virtual Class "ZeroCopyOutputStream"
WriteLittleEndian64-methods | Virtual Class "ZeroCopyOutputStream"
WriteRaw | Virtual Class "ZeroCopyOutputStream"
WriteRaw-method | Virtual Class "ZeroCopyOutputStream"
WriteRaw-methods | Virtual Class "ZeroCopyOutputStream"
WriteString | Virtual Class "ZeroCopyOutputStream"
WriteString-method | Virtual Class "ZeroCopyOutputStream"
WriteString-methods | Virtual Class "ZeroCopyOutputStream"
WriteVarint32 | Virtual Class "ZeroCopyOutputStream"
WriteVarint32-method | Virtual Class "ZeroCopyOutputStream"
WriteVarint32-methods | Virtual Class "ZeroCopyOutputStream"
WriteVarint64 | Virtual Class "ZeroCopyOutputStream"
WriteVarint64-method | Virtual Class "ZeroCopyOutputStream"
WriteVarint64-methods | Virtual Class "ZeroCopyOutputStream"

## -- Z --

ZeroCopyInputStream-class | Virtual Class "ZeroCopyInputStream"
ZeroCopyOutputStream-class | Virtual Class "ZeroCopyOutputStream"

## -- misc --

!=-method | Class "Message"
$-method | Class "Descriptor"
$-method | Class "EnumDescriptor"
$-method | Class "EnumValueDescriptor"
$-method | Class "FieldDescriptor"
$-method | Class "FileDescriptor"
$-method | Class "Message"
$-method | Class "MethodDescriptor"
$-method | Class "ServiceDescriptor"
$-method | Virtual Class "ZeroCopyInputStream"
$-method | Virtual Class "ZeroCopyOutputStream"
$<--method | Class "Descriptor"
$<--method | Class "Message"
$<--method | Class "MethodDescriptor"
.DollarNames.Descriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.EnumDescriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.FieldDescriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.FileDescriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.Message | Completion support for protocol buffer messages and descriptors
.DollarNames.MethodDescriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.ServiceDescriptor | Completion support for protocol buffer messages and descriptors
.DollarNames.ZeroCopyInputStream | Completion support for protocol buffer messages and descriptors
.DollarNames.ZeroCopyOutputStream | Completion support for protocol buffer messages and descriptors
==-method | Class "Message"
[[-method | Class "Descriptor"
[[-method | Class "EnumDescriptor"
[[-method | Class "Message"
[[-method | Class "ServiceDescriptor"
[[<--method | Class "Message"