Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/iancmcc/bingo

Fast, zero-allocation, lexicographic-order-preserving packing/unpacking of native Go types to bytes.
https://github.com/iancmcc/bingo

Last synced: 24 days ago
JSON representation

Fast, zero-allocation, lexicographic-order-preserving packing/unpacking of native Go types to bytes.

Host: GitHub
URL: https://github.com/iancmcc/bingo
Owner: iancmcc
License: mit
Created: 2021-08-22T01:48:48.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-03-14T13:41:24.000Z (2 months ago)
Last Synced: 2024-04-16T19:00:07.938Z (about 1 month ago)
Language: Go
Homepage:
Size: 73.2 KB
Stars: 33
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go-extra - bingo - allocation, lexicographic-order-preserving packing/unpacking of native Go types to bytes.|10|1|0|2021-08-22T01:48:48Z|2022-08-25T03:12:02Z| (Generators / Bit-packing and Compression)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go-projects - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures / Standard CLI)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go-cn - bingo
awesome-go-with-stars - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
repo-1316-awesome-go-cn - bingo
repo-1211-awesome-go-cn - bingo
Go-awesome - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go-cn - bingo
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-resources - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Uncategorized / Uncategorized)
awesome-go-zh - bingo
awesome-go-stars - bingo(stars: 33) - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)
awesome-go - bingo - Fast, zero-allocation, lexicographical-order-preserving packing of native types to bytes. (Data Structures and Algorithms / Bit-packing and Compression)

README

# bingo

[![Go Report Card](https://goreportcard.com/badge/github.com/iancmcc/bingo?style=flat-square)](https://goreportcard.com/report/github.com/iancmcc/bingo)
[![Go Reference](https://pkg.go.dev/badge/github.com/iancmcc/bingo.svg)](https://pkg.go.dev/github.com/iancmcc/bingo)
![Tests](https://github.com/iancmcc/bingo/actions/workflows/tests.yml/badge.svg)
[![Coverage](https://coveralls.io/repos/github/iancmcc/bingo/badge.svg?branch=main)](https://coveralls.io/github/iancmcc/bingo?branch=main)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

Fast, zero-allocation, lexicographic-order-preserving packing/unpacking of native Go types to bytes.

## Features

* Encode `bool`, `string`, `int8`, `int16`, `int32`, `int64`, `uint8`, `uint16`, `uint32`, `uint64`, `float32`, `float64`, and `time.Time`
* Packed values maintain original sort order
* Pack values in descending order
* Pack to an existing byte slice with no additional allocations
* Create and pack values to a new byte slice (one allocation)
* Unpack all values or just specific indexes

## Usage

Import `bingo`:

```go
import "github.com/iancmcc/bingo"
```

### Packing

```go
// Create and return a byte slice with encoded values
key := bingo.MustPack(uint8(12), "cool string bro")

// Now unpack
var (
first uint8
second string
)
bingo.Unpack(key, &first, &second)

// Pack so results will sort the second value descending
key = bingo.WithDesc(false, true, false).MustPack(1, time.Now(), true)

// Just unpack the middle value
var t time.Time
bingo.UnpackIndex(key, 1, &t)

// Pack to an existing byte slice
existingSlice := make([]byte, 100)
key := bingo.MustPackTo(existingSlice, uint16(7), "abc123")
```

## Benchmarks

```sh
$ go test -bench BenchmarkCodecs
```

```
goos: linux
goarch: amd64
pkg: github.com/iancmcc/bingo
cpu: Intel(R) Core(TM) i7-7820HQ
BenchmarkCodecs/int8/encode/natural-8
BenchmarkCodecs/int8/encode/inverse-8
BenchmarkCodecs/int8/decode/natural-8
BenchmarkCodecs/int8/decode/inverse-8
BenchmarkCodecs/int16/encode/natural-8
BenchmarkCodecs/int16/encode/inverse-8
BenchmarkCodecs/int16/decode/natural-8
BenchmarkCodecs/int16/decode/inverse-8
BenchmarkCodecs/int32/encode/natural-8
BenchmarkCodecs/int32/encode/inverse-8
BenchmarkCodecs/int32/decode/natural-8
BenchmarkCodecs/int32/decode/inverse-8
BenchmarkCodecs/int64/encode/natural-8
BenchmarkCodecs/int64/encode/inverse-8
BenchmarkCodecs/int64/decode/natural-8
BenchmarkCodecs/int64/decode/inverse-8
BenchmarkCodecs/float32/encode/natural-8
BenchmarkCodecs/float32/encode/inverse-8
BenchmarkCodecs/float32/decode/natural-8
BenchmarkCodecs/float32/decode/inverse-8
BenchmarkCodecs/float64/encode/natural-8
BenchmarkCodecs/float64/encode/inverse-8
BenchmarkCodecs/float64/decode/natural-8
BenchmarkCodecs/float64/decode/inverse-8
BenchmarkCodecs/string/encode/natural-8
BenchmarkCodecs/string/encode/inverse-8
BenchmarkCodecs/string/decode/natural-8
BenchmarkCodecs/string/decode/inverse-8
BenchmarkCodecs/time/encode/natural-8
BenchmarkCodecs/time/encode/inverse-8
BenchmarkCodecs/time/decode/natural-8
BenchmarkCodecs/time/decode/inverse-8
PASS
ok github.com/iancmcc/bingo 37.644s
``` CPU @ 2.90GHz 100000000 10.35 ns/op 0 B/op 0 allocs/op 89794872 12.60 ns/op 0 B/op 0 allocs/op 65864187 17.11 ns/op 0 B/op 0 allocs/op 63386660 17.27 ns/op 0 B/op 0 allocs/op 100000000 10.04 ns/op 0 B/op 0 allocs/op 85618111 13.08 ns/op 0 B/op 0 allocs/op 64825372 16.55 ns/op 0 B/op 0 allocs/op 58359490 19.44 ns/op 0 B/op 0 allocs/op 120393369 9.942 ns/op 0 B/op 0 allocs/op 80418766 13.67 ns/op 0 B/op 0 allocs/op 53423986 21.03 ns/op 0 B/op 0 allocs/op 47975257 24.68 ns/op 0 B/op 0 allocs/op 100000000 10.95 ns/op 0 B/op 0 allocs/op 67093402 17.79 ns/op 0 B/op 0 allocs/op 47149765 23.97 ns/op 0 B/op 0 allocs/op 39063907 27.36 ns/op 0 B/op 0 allocs/op 100000000 10.42 ns/op 0 B/op 0 allocs/op 79910834 14.11 ns/op 0 B/op 0 allocs/op 63494347 16.88 ns/op 0 B/op 0 allocs/op 46677241 25.55 ns/op 0 B/op 0 allocs/op 100000000 11.05 ns/op 0 B/op 0 allocs/op 62377978 17.48 ns/op 0 B/op 0 allocs/op 62370994 17.26 ns/op 0 B/op 0 allocs/op 54139144 20.68 ns/op 0 B/op 0 allocs/op 47404435 23.80 ns/op 0 B/op 0 allocs/op 29144544 39.74 ns/op 0 B/op 0 allocs/op 39683684 31.39 ns/op 0 B/op 0 allocs/op 23373333 48.06 ns/op 0 B/op 0 allocs/op 47027752 24.72 ns/op 0 B/op 0 allocs/op 38363001 29.22 ns/op 0 B/op 0 allocs/op 42566337 26.76 ns/op 0 B/op 0 allocs/op 30851250 36.88 ns/op 0 B/op 0 allocs/op