summaryrefslogtreecommitdiff
path: root/upb/bindings/ruby/README.md
blob: 12a716999342fa03e188c8573a7cf84d868fe0fa (plain)
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

# Ruby extension

To build, run (from the top upb directory):

    $ make ruby
    $ sudo make install

To test, run:

    $ make rubytest

The binding currently supports:

    - loading message types from descriptors.
    - constructing message instances
    - reading and writing their members
    - parsing and serializing the messages
    - all data types (including nested and repeated)

The binding does *not* currently support:

    - defining message types directly in Ruby code.
    - generating Ruby code for a .proto file.
    - type-checking for setters
    - homogenous / type-checked arrays
    - default values

Because code generation is not currently implemented, the interface to import
a specific message type is kind of clunky for the moment.
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback