cobs

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2024 License: ISC Imports: 0 Imported by: 0

README

Visual

Test CodeQL CodeFactor Language Version Commits License

go-cobs is a Go library implementing Consistent Overhead Byte Stuffing (COBS) functionality.

What is Consistent Overhead Byte Stuffing? Wiki - Technical Paper

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 to visualize go-cobs.

The full API documentation is available on pkg.go.dev.

Additionally, usage 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. 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.

Documentation

Index

Constants

View Source
const (
	Branch  = "master"
	Version = "v1.6.0"
	License = "ISC License"
	Source  = "github.com/justincpresley/go-cobs"
	Created = "2022-07-24"
)

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
examples

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL