package
2.1.0
Repository: https://github.com/golang-tools/redishelper.git
Documentation: pkg.go.dev

# Functions

AddItemPipe 在pipeline中设置布隆过器中的物品@params key string 使用的key@params item string 被设置的物品@params opts ...optparams.Option[AddOpts] 设置add行为的附加参数@returns *BoolValPlacehold 结果的占位符.
AddWithhRefreshTTL 设置总是刷新,对pipeline无效.
AddWithRefreshTTLAtFirstTime 设置第一次创建key时使用MaxTTL设置过期,对pipeline无效.
AddWithTTL 设置总是使用指定的ttl刷新key.
AddWithTTLAtFirstTime 设置第一次创建key时使用指定的ttl设置过期,对pipeline无效.
ExistsItemPipe 在pipeline中设置布隆过器中检查是否已经存在@params key string 使用的key@params item string@return bool 物品是否已经存在.
InfoPipe Pipeline中查看指定bloomfilter的状态@params key string 使用的key.
InsertPipe Pipeline中向布隆过滤器中插入数据,如果不存在就创建@params key string 使用的key@params items []string 待插入数据@params opts ...optparams.Option[InsertOpts] 可选设置项.
InsertWithCapacity 容量,预估物品的数量.当过滤器已经存在时用于创建过滤器.容量越大检索效率越低,但如果超出容量则会默认使用子过滤器扩容,这对检索效率的影响更大.当`NOCREATE`存在时这个设置将失效.
InsertWithErrorRate 碰撞率,当过滤器已经存在时用于创建过滤器.碰撞率设置的越低使用的hash函数越多,使用的空间也越大,检索效率也越低.当`NOCREATE`存在时这个设置将失效.
InsertWithExpansion 当达到容量时进行扩容.
InsertWithNoCreate 如果过滤器不存在则不创建它.这可以用于过滤器创建和过滤器添加之间需要严格分离的地方.`NOCREATE`的优先级高于`CAPACITY`和`ERROR`.
InsertWithNonScaling 如果达到初始容量,防止过滤器创建额外的子过滤器.非缩放过滤器比缩放过滤器需要的内存略少,达到容量时过滤器返回错误.
InsertWithhRefreshTTL 设置总是刷新.
InsertWithRefreshTTLAtFirstTime 设置第一次创建key时使用MaxTTL设置过期.
InsertWithTTL 设置总是使用指定的ttl刷新key.
InsertWithTTLAtFirstTime 设置第一次创建key时使用指定的ttl设置过期.
MAddItemPipe 在pipeline中设置布隆过器的多个物品@params key string 使用的key@params items []string@params opts ...optparams.Option[AddOpts] 设置add行为的附加参数@returns map[string]bool 设置的物品是否在设置前已经存在.
MExistsItemPipe Pipeline中布隆过器中检查复数物品是否已经存在@params key string 使用的key@params item string@return map[string]bool 检查的物品是否已经存在.
New 创建一个新的令牌桶对象@params cli redis.UniversalClient@params opts ...optparams.Option[Options] 设置对象的可选参数.
ReservePipe Pipeline中创建一个布隆过滤器,如果有设置maxttl,则会同时为其设置一个过期@params key string 使用的key@params capacity int64 容量,预估物品的数量,容量越大检索效率越低,但如果超出容量则会默认使用子过滤器扩容,这对检索效率的影响更大@params error_rate float64 碰撞率,碰撞率设置的越低使用的hash函数越多,使用的空间也越大,检索效率也越低@params opts ...optparams.Option[ReserveOpts] 可选设置项.
ReserveWithExpansion 当达到容量时进行扩容.
ReserveWithNonScaling 如果达到初始容量,防止过滤器创建额外的子过滤器.非缩放过滤器比缩放过滤器需要的内存略少,达到容量时过滤器返回错误.
ReserveWithhRefreshTTL 设置使用maxttl设置key的过期,pipeline无效.
ReserveWithTTL 设置使用指定的ttl设置key的过期.
WithAutoRefreshInterval 设置自动刷新过期时间的设置.
WithKey 中间件通用设置,指定使用的键,注意设置后namespace依然有效.
WithMaxTTL 设置token消减间隔时长,单位s.
WithMiddlewaretype 设置中间件类型.
WithNamespace 中间件通用设置,指定锁的命名空间.
WithSpecifiedKey 中间件通用设置,指定使用的键,注意设置key后namespace将失效.
WithTaskCron 设置定时器.

# Variables

No description provided by the author

# Structs

AddOpt filter添加元素物品的参数.
BloomFilter 布隆过滤器对象布隆过滤器常用于去重场景,原理是使用多个hash函数将内容散列至对应的较短的bitmap中,检查时只要所有bitmap中对应位置都没有它即认为未出现,反之则标明已经出现过布隆过滤器有碰撞概率,即并不能保证一定没有重复,而是根据设置的hash函数数量和bitmap长短可以控制碰撞概率的高低.因此也只适合用于并不严格的去重场景,但它可以大大的节省空间.而多数现实场景下,相比较起实打实的花钱买空间尤其是内存空间来说,一个较小的碰撞率往往是可以接受的.
BloomFilterInfo 布隆过滤器状态信息.
No description provided by the author
No description provided by the author
Options broker的配置.
No description provided by the author