bitmask

package

v0.0.19 Latest Latest Go to latest Published: Aug 9, 2023 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Simple utilities for working with bitmasks. Built with generics so any form of unsigned or signed integer is supported.

This section is empty.

This section is empty.

func Add[T Bit](sum, bit T) T

Add adds a given bit to the sum.

func Has[T Bit](sum, bit T) bool

Has checks whether a given bit exists in sum.

func Remove[T Bit](sum, bit T) T

Remove removes bit from the sum.

func Toggle[T Bit](sum, bit T) T

Toggle will either add or remove bit from sum depending on whether it currently exists in the bitmask.

type Bit interface {
	constraints.Integer
}

Bit is a generic type that exports the supported values that can be used in the bitmask. Any form of integer is currently supported.