RProtoBuf (version 0.4.17)

readProtoFiles: protocol buffer descriptor importer

Description

Imports proto files into the descriptor pool that is then used by the P function to resolve message type names.

Usage

readProtoFiles(files, dir, package="RProtoBuf", pattern="\.proto$", lib.loc=NULL)
  readProtoFiles2(files, dir=".", pattern="\.proto$", recursive=FALSE, protoPath=getwd())
  resetDescriptorPool()

Arguments

files

Proto files

dir

Directory. If files is not specified, files with the "proto" extension in the dir directory are imported

package

R package name. If files and dir are missing, "proto" files in the "proto" directory of the package tree are imported.

pattern

A filename pattern to match proto files when using dir.

recursive

Whether to descend recursively into dir.

lib.loc

Library location.

protoPath

Search path for proto file imports.

Value

NULL, invisibly.

Details

readProtoFiles2 is different from readProtoFiles to be consistent with the behavior of protoc command line tool in being explicit about the search path for proto import statements. In addition, we also require that both files and dir arguments are interpreted relative to protoPath, so that there is consistency in future imports of the same files through import statements of other proto files.

resetDescriptorPool clears all imported proto definitions.

See Also

P

Examples

# NOT RUN {
# from a package
readProtoFiles(package = "RProtoBuf")

# from a directory
proto.dir <- system.file("proto", package = "RProtoBuf")
readProtoFiles(dir = proto.dir)

# set of files
proto.files <- list.files(proto.dir, full.names = TRUE)
readProtoFiles(proto.files)
# }