rlespinasse/byteslice

Manipulate of byte slices with endianness ordering support

Hi there

Note I'm not young enough to know everything

See more on https://www.romainlespinasse.dev/about

byteslice's Issues

support extract part of a byte array at bit level

func ExtractBytes(data []byte, lsbPosition, msbPosition uint64) []byte {}
func SizeCalculation(lsbPosition, msbPosition uint64) uint64 {}
func Trim(data []byte, newSize uint64) []byte {}

add coveralls

support https://github.com/mattn/goveralls

Add documentation example for Flip

Use the output bada55 for this example

Add documentation example for RSubset

Use the output bada55 for this example

Add documentation example for LToogle

Use the output bada55 for this example

Add documentation example for RShift

Use the output bada55 for this example

support extract part of a byte

func ExtractBits(a byte, b, c uint8) byte {} 

support little endian on a byte

Add documentation example for Unset

Use the output bada55 for this example

Add documentation example for RPad

Use the output bada55 for this example

Add more tests per functions

• on Bit functions (done by #23)
• on Bits functions (done by #23)
• on ByteArray functions

Add benchmark tests

Add documentation example for Toogle

Use the output bada55 for this example

Add documentation example for LPad

Table-driven tests/benchmarks using subtests

using https://blog.golang.org/subtests

Add documentation example for LUnset

Use the output bada55 for this example

Toogle functions have a small typo

It's Toggle, not Toogle

add travis ci build

support little/big endian on a byte

All current operations must support little endian and big endian operations

support little/big endian operations on a byte array

All operations must support little endian and big endian operations

Use github actions

Add documentation example for LSubset

Use the output bada55 for this example

Add documentation example for RToogle

Use the output bada55 for this example

support mixed endian on a byte array and on the byte level

• support big endian for byte array with little endian of byte
• support little endian for byte array with big endian of byte
• support big endian for byte array with big endian of byte
• support little endian for byte array with little endian of byte

Choose a License (or not)

From https://choosealicense.com/

Possible choices

• MIT License - https://choosealicense.com/licenses/mit/
• Apache 2.0 - https://choosealicense.com/licenses/apache-2.0/
• Unlicense - https://choosealicense.com/licenses/unlicense/

Others license in mind?

Support editorconfig

Add http://editorconfig.org/ file for Golang, Makefile, and Asciidoctor files

Use better names for parameters

Instead of a, b, c use more understandable words like data, lsb (least significant bit), or msb (most significant bit)

support bitwise operations on byte array

Purpose

Support bitwise operations for a []byte value

• The length of 2 byte arrays can be different,
• The current endianness is little endian,
• Support for shift operations will be done by #1.

Support

• AND
• OR
• XOR
• NOT

Function signatures

Bitwise AND

func Mask(data, mask []byte) []byte {}

Bitwise OR

func InclusiveMerge(data1, data2 []byte) []byte {}

Bitwise XOR

func ExclusiveMerge(data1, data2 []byte) []byte {}

Bitwise NOT

func Not(data []byte) []byte {}

add badges

• travis CI
• coveralls

Add documentation example for Set

Use the output bada55 for this example

Add documentation example for LShift

Use the output bada55 for this example

support left and right shift on byte array at a bit level

func RightShift(data []byte, shift uint8) []byte {}
func LeftShift(data []byte, shift uint8) []byte {}

LeftShift and RightShift functions are inversed

Add documentation example for RUnset

Use the output bada55 for this example