File: README.md

package info (click to toggle)
ruby-buftok 0.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 96 kB
  • sloc: ruby: 55; makefile: 2
file content (48 lines) | stat: -rw-r--r-- 1,982 bytes parent folder | download | duplicates (2)
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
# BufferedTokenizer

[![Gem Version](https://badge.fury.io/rb/buftok.png)][gem]
[![Build Status](https://travis-ci.org/sferik/buftok.png?branch=master)][travis]
[![Dependency Status](https://gemnasium.com/sferik/buftok.png?travis)][gemnasium]
[![Code Climate](https://codeclimate.com/github/sferik/buftok.png)][codeclimate]

[gem]: https://rubygems.org/gems/buftok
[travis]: https://travis-ci.org/sferik/buftok
[gemnasium]: https://gemnasium.com/sferik/buftok
[codeclimate]: https://codeclimate.com/github/sferik/buftok

###### Statefully split input data by a specifiable token

BufferedTokenizer takes a delimiter upon instantiation, or acts line-based by
default.  It allows input to be spoon-fed from some outside source which
receives arbitrary length datagrams which may-or-may-not contain the token by
which entities are delimited.  In this respect it's ideally paired with
something like [EventMachine][].

[EventMachine]: http://rubyeventmachine.com/

## Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby
implementations:

* Ruby 1.8.7
* Ruby 1.9.2
* Ruby 1.9.3
* Ruby 2.0.0

If something doesn't work on one of these interpreters, it's a bug.

This library may inadvertently work (or seem to work) on other Ruby
implementations, however support will only be provided for the versions listed
above.

If you would like this library to support another Ruby version, you may
volunteer to be a maintainer. Being a maintainer entails making sure all tests
run and pass on that implementation. When something breaks on your
implementation, you will be responsible for providing patches in a timely
fashion. If critical issues for a particular implementation exist at the time
of a major release, support for that Ruby version may be dropped.

## Copyright
Copyright (c) 2006-2013 Tony Arcieri, Martin Emde, Erik Michaels-Ober.
Distributed under the [Ruby license][license].
[license]: http://www.ruby-lang.org/en/LICENSE.txt