filter

Documentation

Index

• func Add(bucket Key, key []byte) error
• func CheckThenAdd(bucket Key, key []byte) (bool, error)
• func Exists(bucket Key, key []byte) bool
• func Register(h Filter)
• func Remove(bucket Key, key []byte) error
• type Filter
• type Key

Functions

func Add

func Add(bucket Key, key []byte) error

Add will add key to filter bucket

func CheckThenAdd

func CheckThenAdd(bucket Key, key []byte) (bool, error)

CheckThenAdd will check first and if the key is not in the filter bucket, then it will add it and return false, if the key is already in the bucket, it will just return true

func Exists

func Exists(bucket Key, key []byte) bool

Exists checks if the key are already in filter bucket

func Register

func Register(h Filter)

Register used to register filter handler to dealing with filter operations

func Remove

func Remove(bucket Key, key []byte) error

Remove will remove key from bucket

Types

type Filter

type Filter interface {
	Exists(bucket Key, key []byte) bool
	Add(bucket Key, key []byte) error
	Delete(bucket Key, key []byte) error
	CheckThenAdd(bucket Key, key []byte) (bool, error)
}

Filter is used to check if the object is in the filter or not

type Key

type Key string

Key is the key of filters