types

Documentation

Index

• Variables
• type BlobItem
• type BlobIterator
• type BlobIteratorOptions
• type Rat
  • func (r *Rat) Scan(val any) error
  • func (r Rat) Value() (driver.Value, error)
• type Txn
• type Uint64
  • func (u *Uint64) Scan(val any) error
  • func (u Uint64) Value() (driver.Value, error)

Variables

var ErrBlobKeyNotFound = errors.New("blob key not found")

ErrBlobKeyNotFound is returned by blob operations when a key is missing

var ErrBlobStoreUnavailable = errors.New("blob store unavailable")

ErrBlobStoreUnavailable is returned when blob store cannot be accessed

var ErrNilTxn = errors.New("nil transaction")

ErrNilTxn is returned when a nil transaction is provided where a valid transaction is required

var ErrNoStoreAvailable = errors.New("no store available")

ErrNoStoreAvailable is returned when no blob or metadata store is available

var ErrTxnWrongType = errors.New("invalid transaction type")

ErrTxnWrongType is returned when a transaction has the wrong type

Types

type BlobItem

type BlobItem interface {
	Key() []byte
	ValueCopy(dst []byte) ([]byte, error)
}

BlobItem represents a value returned by an iterator

type BlobIterator

type BlobIterator interface {
	Rewind()
	Seek(prefix []byte)
	Valid() bool
	ValidForPrefix(prefix []byte) bool
	Next()
	Item() BlobItem
	Close()
	Err() error
}

BlobIterator provides key iteration over the blob store.

Important lifecycle constraint: items returned by `Item()` must only be accessed while the underlying transaction used to create the iterator is still active. Implementations may validate transaction state at access time (for example `ValueCopy` may fail if the transaction has been committed or rolled back). Typical usage iterates and accesses item values within the same transaction scope.

type BlobIteratorOptions

type BlobIteratorOptions struct {
	Prefix  []byte
	Reverse bool
}

BlobIteratorOptions configures blob iterator creation

type Rat

type Rat struct {
	*big.Rat
}

func (*Rat) Scan

func (r *Rat) Scan(val any) error

func (Rat) Value

func (r Rat) Value() (driver.Value, error)

type Txn

type Txn interface {
	Commit() error
	Rollback() error
}

Txn is a simple transaction handle for commit/rollback only. Database layer (Txn) coordinates metadata and blob operations separately.

type Uint64

type Uint64 uint64

func (*Uint64) Scan

func (u *Uint64) Scan(val any) error

func (Uint64) Value

func (u Uint64) Value() (driver.Value, error)