https://github.com/kaitai-io/kaitai_struct_ruby_runtime

Kaitai Struct: runtime for Ruby
https://github.com/kaitai-io/kaitai_struct_ruby_runtime

kaitai-struct ruby

Last synced: 2 days ago
JSON representation

Kaitai Struct: runtime for Ruby

• Host: GitHub
• URL: https://github.com/kaitai-io/kaitai_struct_ruby_runtime
• Owner: kaitai-io
• License: mit
• Created: 2016-02-20T12:47:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-19T17:26:33.000Z (5 months ago)
• Last Synced: 2024-09-20T01:07:17.272Z (4 months ago)
• Topics: kaitai-struct, ruby
• Language: Ruby
• Homepage: https://rubygems.org/gems/kaitai-struct
• Size: 63.5 KB
• Stars: 18
• Watchers: 10
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kaitai - Repository - io/kaitai_struct_ruby_runtime/issues)) (Runtimes / CI)

README

        
# Kaitai Struct: runtime library for Ruby

[![Gem version](https://img.shields.io/gem/v/kaitai-struct)](https://rubygems.org/gems/kaitai-struct/)

[![Gem downloads](https://img.shields.io/gem/dt/kaitai-struct)](https://rubygems.org/gems/kaitai-struct/#:~:text=TOTAL%20DOWNLOADS)

This library implements Kaitai Struct API for Ruby.

Kaitai Struct is a declarative language used for describe various binary

data structures, laid out in files or in memory: i.e. binary file

formats, network stream packet formats, etc.

Further reading:

* [About Kaitai Struct](http://kaitai.io/)

* [About API implemented in this library](http://doc.kaitai.io/stream_api.html)

## Installing

### Using `Gemfile`

If your project uses Bundler, just include the line

```

gem 'kaitai-struct'

```

in your project's `Gemfile`.

### Using `gem install`

If you have a RubyGems package manager installed, you can use command

```

gem install kaitai-struct

```

to install this runtime library.

### Manually

This library is intentionally kept as very simple, one `.rb` file.

You can just copy it to your project from [this repository](https://github.com/kaitai-io/kaitai_struct_ruby_runtime).

Usually you won't `require` it directly, it will be loaded

by Ruby source code generated by Kaitai Struct compiler.