https://github.com/ngerakines/erlang_protobuffs

A set of Protocol Buffers tools and modules for Erlang applications.
https://github.com/ngerakines/erlang_protobuffs

Last synced: 3 days ago
JSON representation

A set of Protocol Buffers tools and modules for Erlang applications.

• Host: GitHub
• URL: https://github.com/ngerakines/erlang_protobuffs
• Owner: ngerakines
• Created: 2008-12-19T07:56:27.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2020-06-04T10:39:52.000Z (over 4 years ago)
• Last Synced: 2024-12-11T15:47:14.744Z (12 days ago)
• Language: Erlang
• Homepage:
• Size: 340 KB
• Stars: 130
• Watchers: 11
• Forks: 41
• Open Issues: 8
• Metadata Files:
  • Readme: README.markdown
  • Changelog: ChangeLog

Awesome Lists containing this project

README

        
# README

This module is a composite of other open source modules and original code to

make interfacing with the Protocol Buffers protocol easy.

## Encode / Decode

Encoding is simple.

    1> protobuffs:encode(1, 1, uint32).

    <<8,1>>

    2> erlang:iolist_to_binary([

        protobuffs:encode(1, <<"Nick">>, string),

        protobuffs:encode(2, 25, uint32)

    ]).

    <<10,4,78,105,99,107,16,25>>

Decoding is simple too.

    1> protobuffs:decode(<<8, 1>>, uint32).

    {{1, 1}, <<>>}

    2> protobuffs:decode(<<10,4,78,105,99,107,16,25>>, bytes).

    {{1, <<"Nick">>}, <<16,25>>}

    3> protobuffs:decode(<<16,25>>, bytes).

    {{2, 25}, <<>>}

## Using .proto Files

The main objective of this module is to allow developers to use .proto files

easily. This module provides very basic functionality to do so.

Consider the `t/simple.proto` file.

    message Person {

    	required string name = 1;

    	required string address = 2;

    	required string phone_number = 3;

    	required int32 age = 4;

    }

From that file we can create an Erlang module that can encode and decode the

Person message into records.

    1> protobuffs_compile:scan_file("simple.proto").

    ok

	2> simple_pb:decode_person(<<10,4,78,105,99,107,18,13,77,111,...>>).

	{person,<<"Nick">>,<<"Mountain View">>, <<"+1 (000) 555-1234">>,25}

	3> simple_pb:encode_person({person, <<"Nick">>, <<"Mountain View">>,

	    <<"+1 (000) 555-1234">>,25}).

	<<10,4,78,105,99,107,18,13,77,111,117,110,116,97,105,110,32,86,105,...>>

How cool is that? From .proto files, we create modules that export encode and

decode functions for the messages defined.

## CAVEATS

Support for parsing proto files and creating code from it is volatile and

should be considered alpha software at best. It currently only supports flat

messages, simple types (ints, strings, etc) and will break on ENUM types and

any sort of nesting. Please do not use this in production.

## no_debug_info

The protobuffs_compile module relies on the pokemon_pb module being compiled

with debug info. This is because pokemon_pb serves as a template for generated

_pb modules. Running protobuffs_compile:scan_file/1 reads the erlang forms from

the pokemon_pb.beam file and expands and alters those forms to create the generated

module.

## CREDITS

Some of the protobuffs.erl module came from code written by Brian Buchanan.

Some of the protobuffs\_compile.erl module came from code written by Tim

Fletcher.

The rest of it and it's test suite was written by Nick Gerakines. Major

contributions have been made by Jacob Vorreuter.