bitfield

README

go-bitfield

Advanced RLE+ implementation

License

The Filecoin Project is dual-licensed under Apache 2.0 and MIT terms:

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

Documentation

Index

• Variables
• type BitField
  • func IntersectBitField(a, b *BitField) (*BitField, error)
  • func MergeBitFields(a, b *BitField) (*BitField, error)
  • func MultiMerge(bfs ...*BitField) (*BitField, error)
  • func New() BitField
  • func NewFromBytes(rle []byte) (BitField, error)
  • func NewFromIter(r rlepluslazy.RunIterator) (*BitField, error)
  • func NewFromSet(setBits []uint64) *BitField
  • func SubtractBitField(a, b *BitField) (*BitField, error)
  • func (bf BitField) All(max uint64) ([]uint64, error)
  • func (bf BitField) AllMap(max uint64) (map[uint64]bool, error)
  • func (bf *BitField) Copy() (*BitField, error)
  • func (bf BitField) Count() (uint64, error)
  • func (bf *BitField) First() (uint64, error)
  • func (bf *BitField) ForEach(f func(uint64) error) error
  • func (bf *BitField) IsEmpty() (bool, error)
  • func (bf *BitField) IsSet(x uint64) (bool, error)
  • func (bf *BitField) MarshalCBOR(w io.Writer) error
  • func (bf *BitField) MarshalJSON() ([]byte, error)
  • func (bf BitField) Set(bit uint64)
  • func (bf *BitField) Slice(start, count uint64) (*BitField, error)
  • func (bf *BitField) UnmarshalCBOR(r io.Reader) error
  • func (bf *BitField) UnmarshalJSON(b []byte) error
  • func (bf BitField) Unset(bit uint64)

Variables

var ErrBitFieldTooMany = errors.New("to many items in RLE")

Types

type BitField

type BitField struct {
	// contains filtered or unexported fields
}

func IntersectBitField

func IntersectBitField(a, b *BitField) (*BitField, error)

func MergeBitFields

func MergeBitFields(a, b *BitField) (*BitField, error)

func MultiMerge

func MultiMerge(bfs ...*BitField) (*BitField, error)

func New

func New() BitField

func NewFromBytes

func NewFromBytes(rle []byte) (BitField, error)

func NewFromIter

func NewFromIter(r rlepluslazy.RunIterator) (*BitField, error)

func NewFromSet

func NewFromSet(setBits []uint64) *BitField

func SubtractBitField

func SubtractBitField(a, b *BitField) (*BitField, error)

func (BitField) All

func (bf BitField) All(max uint64) ([]uint64, error)

All returns all set set

func (BitField) AllMap

func (bf BitField) AllMap(max uint64) (map[uint64]bool, error)

func (*BitField) Copy

func (bf *BitField) Copy() (*BitField, error)

Copy flushes the bitfield and returns a copy that can be mutated without changing the original values

func (BitField) Count

func (bf BitField) Count() (uint64, error)

func (*BitField) First

func (bf *BitField) First() (uint64, error)

func (*BitField) ForEach

func (bf *BitField) ForEach(f func(uint64) error) error

func (*BitField) IsEmpty

func (bf *BitField) IsEmpty() (bool, error)

func (*BitField) IsSet

func (bf *BitField) IsSet(x uint64) (bool, error)

func (*BitField) MarshalCBOR

func (bf *BitField) MarshalCBOR(w io.Writer) error

func (*BitField) MarshalJSON

func (bf *BitField) MarshalJSON() ([]byte, error)

func (BitField) Set

func (bf BitField) Set(bit uint64)

Set ...s bit in the BitField

func (*BitField) Slice

func (bf *BitField) Slice(start, count uint64) (*BitField, error)

func (*BitField) UnmarshalCBOR

func (bf *BitField) UnmarshalCBOR(r io.Reader) error

func (*BitField) UnmarshalJSON

func (bf *BitField) UnmarshalJSON(b []byte) error

func (BitField) Unset

func (bf BitField) Unset(bit uint64)

Unset ...s bit in the BitField