bitmask

Documentation

Index

• func Has[B Bit, M Bitmask[B]](a, b M) bool
• func Set[B Bit, M Bitmask[B]](a, b M) M
• func String[B Bit, M Bitmask[B]](a M) string
• func Unset[B Bit, M Bitmask[B]](a, b M) M
• type Bit
• type Bitmask

Functions

func Has

func Has[B Bit, M Bitmask[B]](a, b M) bool

Has returns true if (a & b) > 0.

func Set

func Set[B Bit, M Bitmask[B]](a, b M) M

Set returns a new mask of a | b.

func String

func String[B Bit, M Bitmask[B]](a M) string

String returns the stringified version of the mask.

func Unset

func Unset[B Bit, M Bitmask[B]](a, b M) M

Unset returns a new mask of a &^ b.

Types

type Bit

type Bit interface {
	~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64

	// StringValue returns the string-ified value for the bit.
	StringValue() string
}

Bit is a type constraint that includes all unsigned integers.

type Bitmask

type Bitmask[T Bit] interface {
	Bit

	// MaxValue returns the maximum, valid bit that may be set in the mask.
	MaxValue() T
}

Bitmask is a type constraint that can be used as a bitmask.