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

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl -- Event service
      • 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 -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • 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
      • 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
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • base32.pl -- Base32 encoding and decoding
      • 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
      • thread.pl -- High level thread primitives
      • 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
      • mqi.pl
      • optparse.pl -- command line parsing
      • udp_broadcast.pl -- A UDP broadcast proxy
      • make.pl -- Reload modified source files
      • sgml_write.pl -- XML/SGML writer module
      • macros.pl -- Macro expansion
      • check.pl -- Consistency checking
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • redis_streams.pl -- Using Redis streams
      • redis.pl -- Redis client
      • isub.pl -- isub: a string similarity measure
      • stomp.pl -- STOMP client.
      • doc_latex.pl -- PlDoc LaTeX backend
      • system.pl -- System utilities
      • odbc.pl
      • oset.pl -- Ordered set manipulation
      • plunit.pl -- Unit Testing
      • prolog_versions.pl -- Demand specific Prolog versions
      • doc_files.pl -- Create stand-alone documentation files
      • editline.pl -- BSD libedit based command line editing
      • prolog_debug.pl -- User level debugging tools
      • unicode.pl -- Unicode string handling
      • prolog_codewalk.pl -- Prolog code walker
      • threadutil.pl -- Interactive thread utilities
      • edit.pl -- Editor interface
      • explain.pl -- Describe Prolog Terms
      • writef.pl -- Old-style formatted write
      • quintus.pl -- Quintus compatibility
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • pwp.pl -- Prolog Well-formed Pages
      • crypt.pl
      • streams.pl -- Manage Prolog streams
      • help.pl -- Text based manual
      • paxos.pl -- A Replicated Data Store
      • xmldsig.pl -- XML Digital signature
      • archive.pl -- Access several archive formats
      • rdf.pl -- RDF/XML parser
      • readline.pl -- GNU readline interface
      • prolog_trace.pl -- Print access to predicates
      • prolog_wrap.pl -- Wrapping predicates
      • shell.pl -- Elementary shell commands
      • hashtable.pl -- Hash tables
      • table.pl
      • increval.pl -- Incremental dynamic predicate modification
      • intercept.pl -- Intercept and signal interface
      • c14n2.pl -- C14n2 canonical XML documents
      • prolog_profile.pl -- Execution profiler
      • streampool.pl -- Input multiplexing
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • portray_text.pl -- Portray text
      • prolog_autoload.pl -- Autoload all dependencies
      • rewrite_term.pl
      • xsdp_types.pl -- XML-Schema primitive types
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_history.pl -- Per-directory persistent commandline history
      • double_metaphone.pl -- Phonetic string matching
      • test_cover.pl -- Clause coverage analysis
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • tty.pl -- Terminal operations
      • cgi.pl -- Read CGI parameters
      • fastrw.pl -- Fast reading and writing of terms
      • yaml.pl -- Process YAML data
      • rwlocks.pl -- Read/write locks
      • xmlenc.pl -- XML encryption library
      • files.pl
      • rlimit.pl
      • prolog_metainference.pl -- Infer meta-predicate properties
      • readln.pl -- Read line as list of tokens
 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.