package
2.0.1+incompatible
Repository: https://github.com/bpfs/defs.git
Documentation: pkg.go.dev

# Functions

DefaultDecode 是 badgerhold 的默认解码函数,使用 Gob 解码 参数: - data: []byte 类型,表示要解码的字节数据 - value: interface{} 类型,表示要解码到的目标值 返回值: - error: 如果解码过程中出现错误,则返回错误信息.
DefaultEncode 是 badgerhold 的默认编码函数,使用 Gob 编码 参数: - value: interface{} 类型,表示要编码的值 返回值: - []byte: 编码后的字节切片 - error: 如果编码过程中出现错误,则返回错误信息.
NextSequence 用于创建插入时的顺序键 插入时使用 uint64 作为键 store.Insert(badgerhold.NextSequence(), data).
Open 打开或创建一个 BadgerHold 文件 参数: - options: Options 类型,表示要使用的选项 返回值: - *Store: 返回打开的 Store 实例 - error: 如果打开过程中出现错误,则返回错误信息.
Slice 将任何类型的切片转换为 []interface{},通过复制切片值,以便可以轻松传递到接受可变参数的查询中。 如果传入的值不是切片,则会触发 panic 参数: - value: interface{} 类型,表示要转换的切片 返回值: - []interface{}: 转换后的接口切片.
Where 开始一个查询,用于指定 badgerhold 中对象需要匹配的条件 例如: s.Find(badgerhold.Where("FieldName").Eq(value).And("AnotherField").Lt(AnotherValue).

# Constants

BadgerHoldIndexTag 是用于将字段定义为可索引的 badgerhold 结构体标签.
BadgerholdKeyTag 是用于将字段定义为键以用于 Find 查询的结构体标签.
Key 是用于在 badgerhold 中指定查询键的简写,只返回空字符串 例如:Where(badgerhold.Key).Eq("testkey").

# Variables

DefaultOptions 是一组用于打开 BadgerHold 数据库的默认选项 包括 Badger 自己的默认选项.
ErrKeyExists 是在插入已存在的键时返回的错误.
ErrNotFound 在未找到给定键的数据时返回.
ErrUniqueExists 是在插入违反唯一性约束的值时抛出的错误.

# Structs

AggregateResult 允许您访问聚合查询的结果.
Criterion 是一个操作符和一个值,字段需要与之匹配.
ErrTypeMismatch 是在两个类型无法进行比较时抛出的错误类型.
Index 是一个结构体,包含一个返回可索引的编码字节的函数,以及一个标志来指示索引是否唯一.
Options 允许设置不同于默认值的选项 例如,编码和解码函数,默认为 Gob.
Query 是一系列条件的集合,badgerhold 中的对象需要匹配这些条件才能被返回 空查询会匹配所有记录.
RecordAccess 允许在 MatchFunc 中访问当前记录、字段,或运行子查询.
Store 是 badgerhold 的包装器,封装了一个 Badger 数据库.

# Interfaces

Comparer 接口用于将类型与存储中的编码值进行比较。如果当前值等于 other,结果应该是 0; 如果当前值小于 other,则结果应为 -1;如果当前值大于 other,则结果应为 +1。 如果结构体中的字段没有指定 comparer,则使用默认比较(转换为字符串并比较)。 该接口已经为标准 Go 类型以及更复杂的类型(如 time 和 big)进行了处理。 如果类型无法比较,则返回错误。 实现此接口的具体类型将始终以非指针形式传递。.
Storer 是一个接口,用于实现跳过传入 badgerhold 的所有数据的反射调用.

# Type aliases

DecodeFunc 是一个用于从字节解码值的函数类型.
EncodeFunc 是一个用于将值编码为字节的函数类型.
Field 允许引用正在比较的结构中的字段.
KeyList 是一个唯一的、排序的键([]byte)的切片,例如索引所指向的内容.
MatchFunc 是一个用于在查询中测试任意匹配值的函数类型.