bitmap

README

bitmap

Supporting bitmap

• InMemory: wraps bits-and-blooms/bloom
• Redis: integrates go-redis/redis to manipulate bitmap in Redis.

Documentation

Overview

Package bitmap provides ways for filter to manipulate bit set.

Index

• type Bitmap
• type InMemory
  • func NewInMemory(m uint64) *InMemory
  • func (im *InMemory) CheckBits(locs []uint64) (bool, error)
  • func (im *InMemory) SetBits(locs []uint64) error
• type Redis
  • func NewRedis(ctx context.Context, client *redis.Client, key string, m uint64, ...) (*Redis, error)
  • func (r *Redis) CheckBits(locs []uint64) (bool, error)
  • func (r *Redis) SetBits(locs []uint64) error
• type RedisOption
  • func RedisSetExpireTTL(d time.Duration) RedisOption

Types

type Bitmap

type Bitmap interface {
	// CheckBits returns true if all bits on locs have set.
	CheckBits(locs []uint64) (bool, error)
	// SetBits sets all bits on locs.
	SetBits(locs []uint64) error
}

type InMemory

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

func NewInMemory

func NewInMemory(m uint64) *InMemory

NewInMemory returns in-memory bitmap which is backed by github.com/bits-and-blooms/bitset.

func (*InMemory) CheckBits

func (im *InMemory) CheckBits(locs []uint64) (bool, error)

func (*InMemory) SetBits

func (im *InMemory) SetBits(locs []uint64) error

type Redis

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

func NewRedis

func NewRedis(ctx context.Context, client *redis.Client, key string, m uint64, opts ...RedisOption) (*Redis, error)

NewRedis returns bitmap that is store into redis and manipulated via github.com/go-redis/redis.

func (*Redis) CheckBits

func (r *Redis) CheckBits(locs []uint64) (bool, error)

func (*Redis) SetBits

func (r *Redis) SetBits(locs []uint64) error

type RedisOption

type RedisOption func(*Redis) error

func RedisSetExpireTTL

func RedisSetExpireTTL(d time.Duration) RedisOption

RedisSetExpireTTL sets expiry TTL with d.