Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/astroband/ruby-xdr
Read/write XDR encoded data structures (RFC 4506)
https://github.com/astroband/ruby-xdr
data-structures deserialization ruby serialization xdr
Last synced: 8 days ago
JSON representation
Read/write XDR encoded data structures (RFC 4506)
- Host: GitHub
- URL: https://github.com/astroband/ruby-xdr
- Owner: astroband
- License: apache-2.0
- Created: 2015-01-28T23:42:16.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T08:37:29.000Z (7 months ago)
- Last Synced: 2024-04-26T09:44:11.386Z (7 months ago)
- Topics: data-structures, deserialization, ruby, serialization, xdr
- Language: Ruby
- Homepage:
- Size: 183 KB
- Stars: 12
- Watchers: 20
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# XDR, for Ruby
[](https://rubydoc.info/gems/xdr)
[](https://badge.fury.io/rb/xdr)
[](https://github.com/astroband/ruby-xdr/actions/workflows/ci.yml)
[](https://coveralls.io/github/astroband/ruby-xdr?branch=main)
[](https://codeclimate.com/github/stellar/ruby-xdr)
XDR is an open data format, specified in [RFC 4506](http://tools.ietf.org/html/rfc4506.html). This library provides a
way to read and write XDR data from ruby. It can read/write all of the primitive XDR types and also provides facilities
to define readers for the compound XDR types (enums, structs and unions)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'xdr'
```
And then execute:
bundle
Or install it yourself as:
gem install xdr
## Usage
```ruby
# Reading/writing a primitive values
XDR::Bool.to_xdr(false) # => "\x00\x00\x00\x00"
XDR::Bool.from_xdr("\x00\x00\x00\x01") # => true
# Reading/writing arrays
XDR::Array[XDR::Int, 2].to_xdr([1, 2]) # => "\x00\x00\x00\x01\x00\x00\x00\x02"
XDR::Array[XDR::Int, 2].from_xdr("\x00\x00\x00\x03\x00\x00\x00\x04") # => [3,4]
# Defining an enum
class ResultType < XDR::Enum
member :ok, 0
member :error, 1
seal
end
# Using enums
ResultType.ok == ResultType.error # => false
ResultType.to_xdr(ResultType.error) # => "\x00\x00\x00\x01"
ResultType.from_xdr("\x00\x00\x00\x00") # => ResultType.ok(0)
# Defining structs
class MessageWithHash < XDR::Struct
attribute :message, XDR::String[]
attribute :hash, XDR::Opaque[20]
end
# Using structs
s = MessageWithHash.new
s.message = "Hello world"
s.hash = Digest::SHA1.digest(s.message)
xdr = s.to_xdr # => "..."
s2 = MessageWithHash.from_xdr(xdr)
# Defining unions
class Result < XDR::Union
switch_on ResultType, :type
switch :ok
switch :error, :message
attribute :message, XDR::String[]
end
# Constructing unions
Result.ok
Result.error("You didn't say please")
# Using unions
Result.ok.to_xdr # => "\x00\x00\x00\x00"
Result.error("boom").to_xdr # => "\x00\x00\x00\x00\x00\x00\x00\x04boom"
Result.from_xdr("\x00\x00\x00\x00") # => #
```
## Thread safety
Code generated by `xdrgen`, which targets this library, uses autoload extensively. Since autoloading is not thread-safe,
neither is code generated from xdrgen. To work around this, any module including `XDR::Namespace` can be forced to load
all of it's children by calling `load_all!` on the module.
## Code generation
ruby-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom data types.
Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen). `xdrgen` will take your `.x` files
and produce a set of ruby files that target this library to allow for your own custom types.
See [ruby-stellar-base](http://github.com/astroband/ruby-stellar-sdk/tree/master/base/generated) for an example.
## Contributing
1. Fork the repo ( https://github.com/astroband/ruby-xdr/fork )
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create a new Pull Request