protobuf 0.0.6

Rust implementation of Google protocol buffers 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

rust-protobuf
=============

[![Build Status](https://travis-ci.org/stepancheg/rust-protobuf.png)](https://travis-ci.org/stepancheg/rust-protobuf)

[Protobuf](https://developers.google.com/protocol-buffers/docs/overview) implementation in [Rust](http://www.rust-lang.org/).

* Written in pure rust
* Generate rust code
* Has runtime library for generated code
  (Coded{Input|Output}Stream impl)
* Incomplete and unstable

## How to use rust-protobuf

0) Install protobuf for `protoc` binary.

On OS X [Homebrew](https://github.com/mxcl/homebrew) can be used:

```
brew install protobuf
```

On Ubuntu, protobuf-compiler package can be installed:

```
apt-get install protobuf-compiler
```

1) Checkout rust-protobuf sources:

```
git clone git@github.com:stepancheg/rust-protobuf.git -b <branch>
```

Where branch is:
  * `master` compatible rust master
  * `rust-M.N` compatible with rust version M.N.*, e.g. `rust-0.11` for rust 0.11.0

2) Compile the project:

```
cargo build
```

`protoc-gen-rust` binary is generated in `target/` folder. `protoc-gen-rust` is a rust
plugin for protoc.

3) Add `protoc-gen-rust` to $PATH:

```
PATH="`pwd`/target:$PATH"
```

4) Generate .rs files:

```
protoc --rust_out . foo.proto
```

This will generate .rs files in current directory.

Same procedure is used to regenerate .rs files for rust-protobuf
itself, see `./regerate.sh`.

5) Add rust-protobuf as dependency to your project `Cargo.toml`:

```
[dependencies.protobuf]

git = "https://github.com/stepancheg/rust-protobuf.git"
```

6) Include generated files into your project .rs file:

```
extern crate protobuf; // depend on rust-protobuf runtime
mod foo; // add generated file to the project
```


## Generated code

Have a look at generated files, used internally in rust-protobuf:

* [descriptor.rs](https://github.com/stepancheg/rust-protobuf/blob/master/src/lib/descriptor.rs)
  for [descriptor.proto](https://github.com/stepancheg/rust-protobuf/blob/master/src/proto/google/protobuf/descriptor.proto)
  (that is part of Google protobuf)

## TODO

* Implement some rust-specific options
* Deal better with namespaces
* Protobuf reflection
* Extensions
* Generate stubs for services