bolt

package

v1.0.2 Latest Latest Go to latest Published: Mar 14, 2024 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cnk3x/webfx

Documentation ¶

Index ¶

Constants
Variables
func TxAppend[T S](tx BoltTx, bucketName, key, val T) error
func TxDel[B S, K S](tx BoltTx, bucketName B, keys ...K) error
func TxSet[B S, K S, V S](tx BoltTx, bucketName B, key K, value V) error
type BoltBucket
type BoltDB
type BoltTx
type Bucket
- func BucketCreate[T S](tx BoltTx, bucketNames ...T) (bucket *Bucket, err error)
- func BucketOpen[T S](tx BoltTx, bucketNames ...T) (bucket *Bucket, err error)
type BucketStats
type CheckOption
type Cursor
type DB
- func (db *DB) Get(bucketName, key string) (val string, err error)
- func (db *DB) Update(processes ...Process) (err error)
- func (db *DB) View(processes ...Process) (err error)
type FreelistType
type Options
type PageInfo
type Process
- func Append[T S](bucketName, key, val T) Process
- func Del[B S, K S](bucketName B, keys ...K) Process
- func ForEach[T S](bucketName T, fn func(k, v []byte) error) Process
- func ForEachWithPrefix[T S, P S](bucketName T, prefix P, fn func(k, v []byte) error) Process
- func Set[B S, K S, V S](bucketName B, key K, value V) Process
type S
type Stats
type Tx
type TxStats

Constants ¶

View Source

const (
	FreelistArrayType = bbolt.FreelistArrayType
	FreelistMapType   = bbolt.FreelistMapType

	DefaultAllocSize     = bbolt.DefaultAllocSize
	DefaultFillPercent   = bbolt.DefaultFillPercent
	DefaultMaxBatchDelay = bbolt.DefaultMaxBatchDelay
	DefaultMaxBatchSize  = bbolt.DefaultMaxBatchSize
)

Variables ¶

View Source

var (
	Open           = bbolt.Open
	DefaultOptions = bbolt.DefaultOptions
	WithKVStringer = bbolt.WithKVStringer
	HexKVStringer  = bbolt.HexKVStringer
)

View Source

var (
	ErrBucketExists       = bbolt.ErrBucketExists
	ErrBucketNameRequired = bbolt.ErrBucketNameRequired
	ErrBucketNotFound     = bbolt.ErrBucketNotFound
	ErrChecksum           = bbolt.ErrChecksum
	ErrDatabaseNotOpen    = bbolt.ErrDatabaseNotOpen
	ErrDatabaseOpen       = bbolt.ErrDatabaseOpen
	ErrDatabaseReadOnly   = bbolt.ErrDatabaseReadOnly
	ErrFreePagesNotLoaded = bbolt.ErrFreePagesNotLoaded
	ErrIncompatibleValue  = bbolt.ErrIncompatibleValue
	ErrInvalid            = bbolt.ErrInvalid
	ErrInvalidMapping     = bbolt.ErrInvalidMapping
	ErrKeyRequired        = bbolt.ErrKeyRequired
	ErrKeyTooLarge        = bbolt.ErrKeyTooLarge
	ErrTimeout            = bbolt.ErrTimeout
	ErrTxClosed           = bbolt.ErrTxClosed
	ErrTxNotWritable      = bbolt.ErrTxNotWritable
	ErrValueTooLarge      = bbolt.ErrValueTooLarge
	ErrVersionMismatch    = bbolt.ErrVersionMismatch
)

Functions ¶

func TxAppend ¶

func TxAppend[T S](tx BoltTx, bucketName, key, val T) error

func TxDel ¶

func TxDel[B S, K S](tx BoltTx, bucketName B, keys ...K) error

func TxSet ¶

func TxSet[B S, K S, V S](tx BoltTx, bucketName B, key K, value V) error

Types ¶

type BoltBucket ¶

type BoltBucket interface {
	BoltTx
	Put(key, value []byte) error
	Get(key []byte) []byte
	Delete(key []byte) error
	Cursor() *Cursor
	NextSequence() (uint64, error)
	ForEach(fn func(k, v []byte) error) error
}

type BoltDB ¶

type BoltDB = bbolt.DB

type BoltTx ¶

type BoltTx interface {
	Bucket(name []byte) *Bucket
	CreateBucketIfNotExists(name []byte) (*Bucket, error)
	DeleteBucket(key []byte) error
}

type Bucket ¶

type Bucket = bbolt.Bucket

func BucketCreate ¶

func BucketCreate[T S](tx BoltTx, bucketNames ...T) (bucket *Bucket, err error)

func BucketOpen ¶

func BucketOpen[T S](tx BoltTx, bucketNames ...T) (bucket *Bucket, err error)

type BucketStats ¶

type BucketStats = bbolt.BucketStats

type CheckOption ¶

type CheckOption = bbolt.CheckOption

type Cursor ¶

type Cursor = bbolt.Cursor

type DB ¶

type DB struct {
	BoltDB
}

func (*DB) Get ¶

func (db *DB) Get(bucketName, key string) (val string, err error)

func (*DB) Update ¶

func (db *DB) Update(processes ...Process) (err error)

func (*DB) View ¶

func (db *DB) View(processes ...Process) (err error)

type FreelistType ¶

type FreelistType = bbolt.FreelistType

type Options ¶

type Options = bbolt.Options

type PageInfo ¶

type PageInfo = bbolt.PageInfo

type Process ¶

type Process = func(tx *Tx) error

func Append ¶

func Append[T S](bucketName, key, val T) Process

func Del ¶

func Del[B S, K S](bucketName B, keys ...K) Process

func ForEach ¶

func ForEach[T S](bucketName T, fn func(k, v []byte) error) Process

func ForEachWithPrefix ¶

func ForEachWithPrefix[T S, P S](bucketName T, prefix P, fn func(k, v []byte) error) Process

func Set ¶

func Set[B S, K S, V S](bucketName B, key K, value V) Process

type S ¶

type S interface{ ~string | ~[]byte }

type Stats ¶

type Stats = bbolt.Stats

type Tx ¶

type Tx = bbolt.Tx

type TxStats ¶

type TxStats = bbolt.TxStats

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL