https://github.com/justincpresley/go-cobs

go-cobs: Go-to Library for Consistent Overhead Byte Stuffing (COBS) with enhanced features, coded in the Go Language.
https://github.com/justincpresley/go-cobs

cobs cobs-algorithm consistent-overhead-byte-stuffing enhanced frames go golang golang-library networking packet-framing protocol stuffing verification

Last synced: 5 months ago
JSON representation

go-cobs: Go-to Library for Consistent Overhead Byte Stuffing (COBS) with enhanced features, coded in the Go Language.

• Host: GitHub
• URL: https://github.com/justincpresley/go-cobs
• Owner: justincpresley
• License: isc
• Created: 2022-07-25T03:55:59.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T21:27:26.000Z (about 2 years ago)
• Last Synced: 2024-06-21T09:51:22.296Z (almost 2 years ago)
• Topics: cobs, cobs-algorithm, consistent-overhead-byte-stuffing, enhanced, frames, go, golang, golang-library, networking, packet-framing, protocol, stuffing, verification
• Language: Go
• Homepage: https://pkg.go.dev/github.com/justincpresley/go-cobs
• Size: 87.9 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


![Visual](/docs/README_VISUAL.png)

[![Test](https://img.shields.io/github/actions/workflow/status/justincpresley/go-cobs/test.yaml?branch=master&label=Test)][1]

[![CodeFactor](https://img.shields.io/codefactor/grade/github/justincpresley/go-cobs/master?label=CodeFactor)][2]

[![Language](https://img.shields.io/github/go-mod/go-version/justincpresley/go-cobs/master?label=Go)][3]

[![Version](https://img.shields.io/github/v/tag/justincpresley/go-cobs?label=Latest%20version)][4]

[![Commits](https://img.shields.io/github/commits-since/justincpresley/go-cobs/latest/master?label=Unreleased%20commits)][5]

[![License](https://img.shields.io/github/license/justincpresley/go-cobs?label=License)][6]



***go-cobs*** is a [Go](https://go.dev/) library implementing *Consistent Overhead Byte Stuffing* (COBS) functionality.

*What is Consistent Overhead Byte Stuffing?* [Wiki](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing) - [Technical Paper](http://www.stuartcheshire.org/papers/cobsforton.pdf)

The goal of '*COBS*' is to remove a special byte within given data by replacing all special bytes with "flags", a byte telling where the next special byte is. There is minimal overhead with *COBS* as indicated by the paper itself.

## Usage

**It is suggested to try out this library** by running ```go run .``` inside of one the [examples](https://github.com/justincpresley/go-cobs/tree/master/examples) to visualize **go-cobs**.

The full API documentation is available on [pkg.go.dev](https://pkg.go.dev/github.com/justincpresley/go-cobs).

Additionally, [usage](https://github.com/justincpresley/go-cobs/blob/master/docs/USAGE.md) outlines everything you need to know about types, config, and anything that may be unclear outside of the API.

## Notes

***go-cobs*** stands out from other COBS libraries due to [many differences](https://github.com/justincpresley/go-cobs/blob/master/docs/DIFFERENCES.md). This library has discovered advances in COBS that are not stated anywhere else.

## License

***go-cobs*** is an open source project licensed under ISC. See LICENSE.md for more information.

[1]: https://github.com/justincpresley/go-cobs/actions/workflows/test.yaml

[2]: https://www.codefactor.io/repository/github/justincpresley/go-cobs

[3]: https://go.dev/

[4]: https://github.com/justincpresley/go-cobs/releases

[5]: https://github.com/justincpresley/go-cobs/compare/v1.6.0...HEAD

[6]: https://en.wikipedia.org/wiki/ISC_license