Package: RProtoBuf 0.4.22

Dirk Eddelbuettel

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

Protocol Buffers are a way of encoding structured data in an efficient yet extensible format. Google uses Protocol Buffers for almost all of its internal 'RPC' protocols and file formats. Additional documentation is available in two included vignettes one of which corresponds to our 'JSS' paper (2016, <doi:10.18637/jss.v071.i02>. A sufficiently recent version of 'Protocol Buffers' library is required; currently version 3.3.0 from 2017 is the stated minimum.

Authors:Romain Francois, Dirk Eddelbuettel, Murray Stokely and Jeroen Ooms

RProtoBuf_0.4.22.tar.gz
RProtoBuf_0.4.22.tar.gz(r-4.5-noble)RProtoBuf_0.4.22.tar.gz(r-4.4-noble)
RProtoBuf.pdf |RProtoBuf.html✨
RProtoBuf/json (API)
NEWS

# Install 'RProtoBuf' in R:
install.packages('RProtoBuf', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/eddelbuettel/rprotobuf/issues

Uses libs:
  • protobuf– Protocol buffers C++ library
  • c++– GNU Standard C++ Library v3

protobufcpp

6.44 score 2 stars 20 packages 125 scripts 1.2k downloads 118 exports 1 dependencies

Last updated 11 months agofrom:b71ff323c7. Checks:OK: 2. Indexed: no.

TargetResultDate
Doc / VignettesOKDec 25 2024
R-4.5-linux-x86_64OKDec 25 2024

Exports:addall.equalArrayInputStreamArrayOutputStreamasMessageBackUpByteCountbytesizecan_serialize_pbclearclonecloseConnectionInputStreamConnectionOutputStreamcontaining_typecpp_typeCPPTYPE_BOOLCPPTYPE_DOUBLECPPTYPE_ENUMCPPTYPE_FLOATCPPTYPE_INT32CPPTYPE_INT64CPPTYPE_MESSAGECPPTYPE_STRINGCPPTYPE_UINT32CPPTYPE_UINT64default_valuedescriptorenum_typeenum_type_countfetchfieldfield_countfileDescriptorFileInputStreamFileOutputStreamflushGetErrnogetExtensionhashas_default_valueidenticalinput_typeis_extensionis_optionalis_repeatedis_requiredisInitializedlabelLABEL_OPTIONALLABEL_REPEATEDLABEL_REQUIREDmergemessage_typemethodmethod_countnamenested_typenested_type_countnewNextnumberoutput_typePreadreadASCIIreadJSONReadLittleEndian32ReadLittleEndian64readProtoFilesreadProtoFiles2ReadRawReadStringReadVarint32ReadVarint64resetDescriptorPoolserializeserialize_pbsetSetCloseOnDeletesetExtensionshowsizesize<-SkipstrswaptoJSONtoStringtypeTYPE_BOOLTYPE_BYTESTYPE_DOUBLETYPE_ENUMTYPE_FIXED32TYPE_FIXED64TYPE_FLOATTYPE_GROUPTYPE_INT32TYPE_INT64TYPE_MESSAGETYPE_SFIXED32TYPE_SFIXED64TYPE_SINT32TYPE_SINT64TYPE_STRINGTYPE_UINT32TYPE_UINT64unserialize_pbupdatevaluevalue_countWriteLittleEndian32WriteLittleEndian64WriteRawWriteStringWriteVarint32WriteVarint64

Dependencies:Rcpp

RProtoBuf-intro

Rendered fromRProtoBuf-intro.Rnwusingutils::Sweaveon Dec 25 2024.

Last update: 2020-02-08
Started: 2012-08-08

RProtoBuf-paper

Rendered fromRProtoBuf-paper.Rnwusingutils::Sweaveon Dec 25 2024.

Last update: 2020-02-08
Started: 2016-07-11

RProtoBuf-quickref

Rendered fromRProtoBuf-quickref.Rnwusingutils::Sweaveon Dec 25 2024.

Last update: 2020-02-08
Started: 2012-08-08

Readme and manuals

Help Manual

Help pageTopics
R Interface to the Protocol Buffers APIRProtoBuf-package RProtoBuf
add elements of a repeated field of a messageadd add,Message-method add-methods
Class "ArrayInputStream"ArrayInputStream-class
Creates an ArrayInputStreamArrayInputStream ArrayInputStream,raw,integer-method ArrayInputStream,raw,missing-method ArrayInputStream,raw,numeric-method ArrayInputStream-methods
Class "ArrayOutputStream"ArrayOutputStream-class
Creates an ArrayOutputStreamArrayOutputStream ArrayOutputStream,integer,integer-method ArrayOutputStream,integer,missing-method ArrayOutputStream,integer,numeric-method ArrayOutputStream,numeric,integer-method ArrayOutputStream,numeric,missing-method ArrayOutputStream,numeric,numeric-method ArrayOutputStream-methods
Grab the protocol buffer message as an R listas.list.Descriptor as.list.EnumDescriptor as.list.FileDescriptor as.list.Message as.list.ServiceDescriptor
coerce an object to a protobuf messageasMessage
Backs up a number of bytes from a streamBackUp BackUp-methods
The number of bytes read/written since the object was createdByteCount ByteCount-methods
The number of bytes taken by a messagebytesize bytesize,Message-method bytesize-methods
Clear a field or all fields of the message and set them to their default valuesclear clear,Message,character-method clear,Message,integer-method clear,Message,missing-method clear,Message,numeric-method clear,Message,raw-method clear-methods
Clone protocol buffer messagesclone clone,Message-method clone-methods
Completion support for protocol buffer messages and descriptors.DollarNames.Descriptor .DollarNames.EnumDescriptor .DollarNames.FieldDescriptor .DollarNames.FileDescriptor .DollarNames.Message .DollarNames.MethodDescriptor .DollarNames.ServiceDescriptor .DollarNames.ZeroCopyInputStream .DollarNames.ZeroCopyOutputStream
Class "ConnectionInputStream"ConnectionInputStream-class
Creates an ConnectionInputStreamConnectionInputStream ConnectionInputStream,connection-method ConnectionInputStream-methods
Class "ConnectionOutputStream"ConnectionOutputStream-class
Creates an ConnectionOutputStreamConnectionOutputStream ConnectionOutputStream,connection-method ConnectionOutputStream-methods
Gets the message type descriptor that contains a descriptorcontaining_type containing_type-methods
Class "Descriptor"$,Descriptor-method $<-,Descriptor-method as.character,Descriptor-method containing_type,Descriptor-method Descriptor-class enum_type,Descriptor,ANY,ANY-method enum_type_count,Descriptor-method field,Descriptor-method field_count,Descriptor-method length,Descriptor-method names,Descriptor-method nested_type,Descriptor-method nested_type_count,Descriptor-method new,Descriptor-method show,Descriptor-method toString,Descriptor-method [[,Descriptor-method
Get the descriptor of a messagedescriptor descriptor,Message-method descriptor-methods
The number of enum typesenum_type_count enum_type_count-methods
Extract an enum type descriptor for a nested typeenum_type enum_type-methods
Class "EnumDescriptor"$,EnumDescriptor-method as.character,EnumDescriptor-method containing_type,EnumDescriptor-method EnumDescriptor-class has,EnumDescriptor-method length,EnumDescriptor-method names,EnumDescriptor-method show,EnumDescriptor-method toString,EnumDescriptor-method value value,EnumDescriptor-method value-methods value_count value_count,EnumDescriptor-method value_count-methods [[,EnumDescriptor-method
Class "EnumValueDescriptor"$,EnumValueDescriptor-method as.character,EnumValueDescriptor-method EnumValueDescriptor-class enum_type,EnumValueDescriptor,missing,missing-method name,EnumValueDescriptor-method number,EnumValueDescriptor-method show,EnumValueDescriptor-method toString,EnumValueDescriptor-method
Fetch content of a repeated fieldfetch fetch,Message-method fetch-methods
The number of fieldsfield_count field_count-methods
Extract a field descriptorfield field-methods
Class "FieldDescriptor"$,FieldDescriptor-method as.character,FieldDescriptor-method containing_type,FieldDescriptor-method cpp_type,FieldDescriptor-method default_value default_value,FieldDescriptor-method default_value-methods enum_type,FieldDescriptor,missing,missing-method FieldDescriptor-class has_default_value has_default_value,FieldDescriptor-method has_default_value-methods is_extension,FieldDescriptor-method is_optional is_optional,FieldDescriptor-method is_optional-methods is_repeated is_repeated,FieldDescriptor-method is_repeated-methods is_required is_required,FieldDescriptor-method is_required-methods label,FieldDescriptor-method message_type message_type,FieldDescriptor-method message_type-methods number,FieldDescriptor-method show,FieldDescriptor-method toString,FieldDescriptor-method type,FieldDescriptor-method
Class "FileDescriptor"$,FileDescriptor-method as.character,FileDescriptor-method FileDescriptor-class name,FileDescriptor-method show,FileDescriptor-method toString,FileDescriptor-method
gets the file descriptor of an objectfileDescriptor fileDescriptor,Descriptor-method fileDescriptor,EnumDescriptor-method fileDescriptor,FieldDescriptor-method fileDescriptor,Message-method fileDescriptor,MethodDescriptor-method fileDescriptor,ServiceDescriptor-method fileDescriptor-methods
Class "FileInputStream"close,FileInputStream-method FileInputStream-class GetErrno,FileInputStream-method SetCloseOnDelete,FileInputStream-method
Creates an FileInputStreamFileInputStream FileInputStream,character,integer,logical-method FileInputStream-methods
Class "FileOutputStream"close,FileOutputStream-method FileOutputStream-class flush,FileOutputStream-method GetErrno,FileOutputStream-method SetCloseOnDelete,FileOutputStream-method
Creates an FileOutputStreamFileOutputStream FileOutputStream,character,integer,logical-method FileOutputStream-methods
Get the error number for an I/O errorGetErrno GetErrno-methods
Indicates if an object has the given field sethas has,Message-method has-methods
Indicates if a field descriptor is an extensionis_extension is_extension-methods
Indicates if a protocol buffer message is initializedisInitialized isInitialized,Message-method isInitialized-methods
Gets the label of a fieldlabel label-methods LABEL_OPTIONAL LABEL_REPEATED LABEL_REQUIRED
Merge two messages of the same typemerge,Message,Message-method
Class "Message"!=,Message,Message-method $,Message-method $<-,Message-method ==,Message,Message-method all.equal,Message,Message-method as.character,Message-method getExtension getExtension,Message-method identical,Message,Message-method length,Message-method Message-class names,Message-method serialize,Message-method setExtension setExtension,Message-method show,Message-method str,Message-method toJSON toJSON,Message-method toString,Message-method update,Message-method [[,Message-method [[<-,Message-method
Class "MethodDescriptor"$,MethodDescriptor-method $<-,MethodDescriptor-method as.character,MethodDescriptor-method input_type input_type,MethodDescriptor-method input_type-methods MethodDescriptor-class output_type output_type,MethodDescriptor-method output_type-methods toString,MethodDescriptor-method
Name or full name of a descriptorname name,Descriptor-method name,EnumDescriptor-method name,FieldDescriptor-method name,MethodDescriptor-method name,ServiceDescriptor-method name-methods
The number of fieldsnested_type_count nested_type_count-methods
Extract a message type descriptor for a nested typenested_type nested_type-methods
Obtains a chunk of data from the streamNext Next-methods
Gets the declared tag number of a fieldnumber number-methods
Protocol Buffer descriptor importerP
Read a protocol buffer message from a connectionread read,Descriptor,ANY-method read,Descriptor,character-method read,Descriptor,raw-method read-methods
read a message in ASCII formatreadASCII readASCII,Descriptor,ANY-method readASCII,Descriptor,character-method readASCII-methods
read a message in JSON formatreadJSON readJSON,Descriptor,ANY-method readJSON,Descriptor,character-method readJSON-methods
protocol buffer descriptor importerreadProtoFiles readProtoFiles2 resetDescriptorPool
Serialize R object to Protocol Buffer Message.can_serialize_pb serialize_pb unserialize_pb
Class "ServiceDescriptor"$,ServiceDescriptor-method as.character,ServiceDescriptor-method length,ServiceDescriptor-method method method,ServiceDescriptor-method method-methods method_count method_count,ServiceDescriptor-method method_count-methods ServiceDescriptor-class show,ServiceDescriptor-method toString,ServiceDescriptor-method [[,ServiceDescriptor-method
set a subset of values of a repeated field of a messageset set,Message-method set-methods
set the close on delete behaviorSetCloseOnDelete SetCloseOnDelete-methods
Size of a message fieldsize size,Message-method size-methods
Set the size of a fieldsize<- size<-,Message-method size<--methods
Skips a number of bytesSkip Skip-methods
swap elements of a repeated field of a messageswap swap,Message-method swap-methods
Gets the type or the C++ type of a fieldCPPTYPE_BOOL CPPTYPE_DOUBLE CPPTYPE_ENUM CPPTYPE_FLOAT CPPTYPE_INT32 CPPTYPE_INT64 CPPTYPE_MESSAGE CPPTYPE_STRING CPPTYPE_UINT32 CPPTYPE_UINT64 cpp_type cpp_type-methods type type-methods TYPE_BOOL TYPE_BYTES TYPE_DOUBLE TYPE_ENUM TYPE_FIXED32 TYPE_FIXED64 TYPE_FLOAT TYPE_GROUP TYPE_INT32 TYPE_INT64 TYPE_MESSAGE TYPE_SFIXED32 TYPE_SFIXED64 TYPE_SINT32 TYPE_SINT64 TYPE_STRING TYPE_UINT32 TYPE_UINT64
with and within methods for protocol buffer messageswith.Message within.Message
Virtual Class "ZeroCopyInputStream"$,ZeroCopyInputStream-method BackUp,ZeroCopyInputStream-method ByteCount,ZeroCopyInputStream-method Next,ZeroCopyInputStream,missing-method ReadLittleEndian32 ReadLittleEndian32,ZeroCopyInputStream-method ReadLittleEndian32-methods ReadLittleEndian64 ReadLittleEndian64,ZeroCopyInputStream-method ReadLittleEndian64-methods ReadRaw ReadRaw,ZeroCopyInputStream,integer-method ReadRaw,ZeroCopyInputStream,numeric-method ReadRaw-methods ReadString ReadString,ZeroCopyInputStream,integer-method ReadString,ZeroCopyInputStream,numeric-method ReadString-methods ReadVarint32 ReadVarint32,ZeroCopyInputStream-method ReadVarint32-methods ReadVarint64 ReadVarint64,ZeroCopyInputStream-method ReadVarint64-methods Skip,ZeroCopyInputStream-method ZeroCopyInputStream-class
Virtual Class "ZeroCopyOutputStream"$,ZeroCopyOutputStream-method BackUp,ZeroCopyOutputStream-method ByteCount,ZeroCopyOutputStream-method Next,ZeroCopyOutputStream,raw-method WriteLittleEndian32 WriteLittleEndian32,ZeroCopyOutputStream,integer-method WriteLittleEndian32,ZeroCopyOutputStream,numeric-method WriteLittleEndian32,ZeroCopyOutputStream,raw-method WriteLittleEndian32-methods WriteLittleEndian64 WriteLittleEndian64,ZeroCopyOutputStream,integer-method WriteLittleEndian64,ZeroCopyOutputStream,numeric-method WriteLittleEndian64,ZeroCopyOutputStream,raw-method WriteLittleEndian64-methods WriteRaw WriteRaw,ZeroCopyOutputStream,raw-method WriteRaw-methods WriteString WriteString,ZeroCopyOutputStream,character-method WriteString-methods WriteVarint32 WriteVarint32,ZeroCopyOutputStream,integer-method WriteVarint32,ZeroCopyOutputStream,numeric-method WriteVarint32,ZeroCopyOutputStream,raw-method WriteVarint32-methods WriteVarint64 WriteVarint64,ZeroCopyOutputStream,integer-method WriteVarint64,ZeroCopyOutputStream,numeric-method WriteVarint64,ZeroCopyOutputStream,raw-method WriteVarint64-methods ZeroCopyOutputStream-class