/usr/lib/swipl/library/protobufs.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl
      • lists.pl -- List Manipulation
      • debug.pl
      • broadcast.pl
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • uid.pl -- User and group management on Unix systems
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl
      • arithmetic.pl -- Extensible arithmetic
      • main.pl -- Provide entry point for scripts
      • readutil.pl -- Read utilities
      • ssl.pl
      • crypto.pl
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl -- Prolog syntax colouring support.
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • editline.pl -- BSD libedit based command line editing
      • sgml_write.pl -- XML/SGML writer module
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • tables.pl -- XSB interface to tables
      • optparse.pl -- command line parsing
      • xmldsig.pl -- XML Digital signature
      • archive.pl -- Access several archive formats
      • intercept.pl -- Intercept and signal interface
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_history.pl -- Per-directory persistent commandline history
      • fastrw.pl -- Fast reading and writing of terms
      • edit.pl -- Editor interface
      • odbc.pl
      • macros.pl -- Macro expansion
      • redis_streams.pl -- Using Redis streams
      • redis.pl -- Redis client
      • udp_broadcast.pl -- A UDP broadcast proxy
      • rdf_triple.pl -- Create triples from intermediate representation
      • prolog_trace.pl -- Print access to predicates
      • system.pl -- System utilities
      • explain.pl -- Describe Prolog Terms
      • xsdp_types.pl -- XML-Schema primitive types
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • test_cover.pl -- Clause coverage analysis
      • xmlenc.pl -- XML encryption library
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • quintus.pl -- Quintus compatibility
      • shell.pl -- Elementary shell commands
      • prolog_wrap.pl -- Wrapping predicates
      • thread.pl -- High level thread primitives
      • portray_text.pl -- Portray text
      • check.pl -- Consistency checking
      • paxos.pl -- A Replicated Data Store
      • c14n2.pl -- C14n2 canonical XML documents
      • stomp.pl -- STOMP client.
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
        • protobuf_parse_from_codes/3
        • protobuf_serialize_to_codes/3
        • protobuf_message/2
        • protobuf_message/3
        • protobuf_field_is_map/2
        • protobuf_map_pairs/3
      • prolog_debug.pl -- User level debugging tools
      • doc_files.pl -- Create stand-alone documentation files
      • streampool.pl -- Input multiplexing
      • plunit.pl -- Unit Testing
      • threadutil.pl -- Interactive thread utilities
      • prolog_profile.pl -- Execution profiler
      • prolog_autoload.pl -- Autoload all dependencies
      • yaml.pl -- Process YAML data
      • table.pl
      • unicode.pl -- Unicode string handling
      • pwp.pl -- Prolog Well-formed Pages
      • readline.pl -- GNU readline interface
      • double_metaphone.pl -- Phonetic string matching
      • mqi.pl
      • make.pl -- Reload modified source files
      • rdf_parser.pl
      • rewrite_term.pl
      • prolog_versions.pl -- Demand specific Prolog versions
      • increval.pl -- Incremental dynamic predicate modification
      • crypt.pl
      • isub.pl -- isub: a string similarity measure
      • help.pl -- Text based manual
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_metainference.pl -- Infer meta-predicate properties
      • rdf.pl -- RDF/XML parser
      • writef.pl -- Old-style formatted write
      • oset.pl -- Ordered set manipulation
      • doc_latex.pl -- PlDoc LaTeX backend
      • hashtable.pl -- Hash tables
      • tty.pl -- Terminal operations
      • streams.pl -- Manage Prolog streams
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • rlimit.pl
      • cgi.pl -- Read CGI parameters
      • readln.pl -- Read line as list of tokens
      • files.pl
      • rwlocks.pl -- Read/write locks
 protobuf_serialize_to_codes(+Term:dict, -MessageType:atom, -WireCodes:list(int)) is det
Process a Prolog term into bytes (list of int) that is the serialized form of a message (designated by MessageType).

Protoc must have been run (with the --swipl_out= option and the resulting top-level _pb.pl file loaded. For more details, see the "protoc" section of the overview documentation.

Fails if the term isn't of an appropriate form or if the appropriate meta-data from protoc hasn't been loaded, or if a field name is incorrect (and therefore nothing in the meta-data matches it).

Arguments:
Term- The Prolog form of the data, as nested dicts.
MessageType- Fully qualified message name (from the .proto file's package and message). For example, if the package is google.protobuf and the message is FileDescriptorSet, then you would use '.google.protobuf.FileDescriptorSet' or 'google.protobuf.FileDescriptorSet'. If there's no package name, use e.g.: 'MyMessage or '.MyMessage'. You can see the packages by looking at protobufs:proto_meta_package(Pkg,File,_) and the message names and fields by protobufs:proto_meta_field_name('.google.protobuf.FileDescriptorSet', FieldNumber, FieldName, FqnName) (the initial '.' is not optional for these facts, only for the top-level name given to protobuf_serialize_to_codes/3).
WireCodes- Wire format of the message, which can be output using format('~s', [WireCodes]).
Errors
- version_error(Module-Version) you need to recompile the Module with a newer version of protoc.
- existence_error if a field can't be found in the meta-data
See also
- library(protobufs): Google's Protocol Buffers
bug
- map fields don't get special treatment (but see protobuf_map_pairs/3).
- oneof is not checked for validity.