bitfield

Documentation

Overview

Package bitfield provides a simple and efficient arbitrary size bit field implementation. It doesn't attempt to cover everything that could be done with bit fields, providing only things used by neo-go.

Index

• type Field
  • func New(n int) Field
  • func (f Field) And(m Field)
  • func (f Field) Copy() Field
  • func (f Field) Equals(o Field) bool
  • func (f Field) IsSet(i int) bool
  • func (f Field) IsSubset(o Field) bool
  • func (f Field) Set(i int)

Types

type Field

type Field []uint64

Field is a bit field represented as a slice of uint64 values.

func New

func New(n int) Field

New creates a new bit field of the specified length. Actual field length can be rounded to the next multiple of 64, so it's a responsibility of the user to deal with that.

func (Field) And

func (f Field) And(m Field)

And implements logical AND between f's and m's bits saving the result into f.

func (Field) Copy

func (f Field) Copy() Field

Copy makes a copy of the current Field.

func (Field) Equals

func (f Field) Equals(o Field) bool

Equals compares two Fields and returns true if they're equal.

func (Field) IsSet

func (f Field) IsSet(i int) bool

IsSet returns true if the bit with the specified offset is set.

func (Field) IsSubset

func (f Field) IsSubset(o Field) bool

IsSubset returns true when f is a subset of o (only has bits set that are set in o).

func (Field) Set

func (f Field) Set(i int)

Set sets one bit at the specified offset. No bounds checking is done.