https://github.com/daurnimator/fifo.lua

Fifo library for Lua
https://github.com/daurnimator/fifo.lua

data-structures fifo lua

Last synced: 2 months ago
JSON representation

Fifo library for Lua

• Host: GitHub
• URL: https://github.com/daurnimator/fifo.lua
• Owner: daurnimator
• License: mit
• Created: 2015-03-16T21:36:28.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2020-12-03T12:50:37.000Z (about 4 years ago)
• Last Synced: 2024-10-05T14:49:29.326Z (3 months ago)
• Topics: data-structures, fifo, lua
• Language: Lua
• Size: 26.4 KB
• Stars: 35
• Watchers: 8
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A lua library/'class' that implements a FIFO.

Objects in the fifo can be of any type, including `nil`.

Compatible with Lua 5.1, 5.2, 5.3, 5.4 and LuaJIT

# Status

This project has been used in production since 2012.

[![Build Status](https://travis-ci.org/daurnimator/fifo.lua.svg)](https://travis-ci.org/daurnimator/fifo.lua)

[![Coverage Status](https://coveralls.io/repos/daurnimator/fifo.lua/badge.svg?branch=master)](https://coveralls.io/r/daurnimator/fifo.lua?branch=master)

# Documentation

Please see the `doc/` folder.

You can generate a man page using [pandoc](http://pandoc.org/):

```

pandoc doc/index.md -s -t man -o /usr/local/share/man/man3/fifo.lua.3

```

# Installation

Available via luarocks: `luarocks install fifo`

Alternatively, you may just copy fifo.lua to your own project.

# Tests

You will need

  - [busted](http://olivinelabs.com/busted/)

  - [luacov](https://keplerproject.github.io/luacov/)

Run `busted -c` to run tests

You can then generate a coverage report by running `luacov`

(it will write the report to luacov.report.out)

# History

This was previously a component of [lomp](https://github.com/daurnimator/lomp2)

but was useful enough in other projects that I split it out.