https://github.com/et-nik/binngo

Binary serialization. Implements easy to use encoding and decoding of Binn.
https://github.com/et-nik/binngo

binary serialization

Last synced: 8 days ago
JSON representation

Binary serialization. Implements easy to use encoding and decoding of Binn.

• Host: GitHub
• URL: https://github.com/et-nik/binngo
• Owner: et-nik
• License: mit
• Created: 2021-05-22T09:15:01.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-12-13T11:54:06.000Z (about 1 year ago)
• Last Synced: 2024-12-23T13:48:04.582Z (17 days ago)
• Topics: binary, serialization
• Language: Go
• Homepage:
• Size: 66.4 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
BinnGo

=======================

[![Go Reference](https://pkg.go.dev/badge/github.com/et-nik/binngo.svg)](https://pkg.go.dev/github.com/et-nik/binngo)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/et-nik/binngo)

[![Go Report Card](https://goreportcard.com/badge/github.com/et-nik/binngo)](https://goreportcard.com/report/github.com/et-nik/binngo)

[![test](https://github.com/et-nik/binngo/actions/workflows/test.yml/badge.svg)](https://github.com/et-nik/binngo/actions/workflows/test.yml)

[![Code Coverage](https://scrutinizer-ci.com/g/et-nik/binngo/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/et-nik/binngo/?branch=master)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/et-nik/binngo/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/et-nik/binngo/?branch=master)

Binary serializer. Implements easy to use encoding and decoding of Binn. This package is very similar to the standard go

encoder packages like `encoding/json`. BinnGo uses reflection.

Original C Binn Library: https://github.com/liteserver/binn

Binn Specification: https://github.com/liteserver/binn/blob/master/spec.md

## Work In Progress notification

This package in under development. Encoding and decoding complex and nested structures may not work as expected.

## Installation

Run the following command to install the package:

```

go get -u github.com/et-nik/binngo

```

## How To Use

### Reading Binn data

```go

package main

import (

	"fmt"

	"github.com/et-nik/binngo"

)

func main() {

	binnBinary := []byte{

		0xE0,                          // [type] list (container)

		23,                            // [size] container total size

		0x02,                          // [count] items

		0xA0,                          // [type] = string

		0x05,                          // [size]

		'h', 'e', 'l', 'l', 'o', 0x00, // [data] (null terminated)

		0xA0,                          // [type] = string

		0x05,                          // [size]

		'w', 'o', 'r', 'l', 'd', 0x00, // [data] (null terminated)

	}

	items := []string{}

	err := binngo.Unmarshal(binnBinary, &items)

	if err != nil {

		fmt.Println("error:", err)

	}

	fmt.Printf("%+v", items)

}

```

### Writing Binn data

```go

package main

import (

	"fmt"

	"io/ioutil"

	"github.com/et-nik/binngo"

)

func main() {

	structure := struct {

		Val1 int64

		Val2 string

	}{

		123,

		"value",

	}

	binnBinary, err := binngo.Marshal(structure)

	if err != nil {

		fmt.Println("error:", err)

	}

	err = ioutil.WriteFile("/path/to/binfile", binnBinary, 0644)

	if err != nil {

		fmt.Println("error:", err)

	}

}

```

## License

This project is licensed under the MIT License - see the LICENSE file for details.