Nim BIPF

BIPF is a binary format for data interchange, designed to be compact and fast to parse.

This library provides a Nim implementation of BIPF, with support for both reading, writing, searching.

Status: Work in progress, prefer pointing to the github repository for now in the requires section of your nimble file.

Installation

For Nim library:

nimble install https://github.com/BundleFeed/nim_bipf

To use the BIPF.tinySSB variant, add the tinySSB flag: -d:tinySSB

For NPM library:

```bash
npm install nim_bipf

Backends

• Nim library
• Pure JS library (to deploy in the browser use NodeJs Buffer polyfill or some packager)
• Compatibility layer with https://www.npmjs.com/package/bipf (pass all tests but those that are not compliant with the spec in this implementation)
• NodeJs Module (build with cmake-js)
• WebAssembly Module
• Spec pull request implementation Convert NULLBOOL type to ATOM type
• support BIPF.tinySSB (https://github.com/ssbc/sips/blob/master/011.md)

Performance

For JS

A benchmark (results) is available in the tests-js folder. To run it:

nimble benchJs

or

npm run benchmark

It compares the performances of

• the reference JS implementation: https://www.npmjs.com/package/bipf
• Nim implementation compiled to JS backend
• Nim implementation compiled to NodeJs Module

License

Wrapper License

This repository is licensed and distributed under either of

• MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT

or

• Apache License, Version 2.0, (LICENSE-APACHEv2 or http://www.apache.org/licenses/LICENSE-2.0)

at your option. This file may not be copied, modified, or distributed except according to those terms.