capacitor

Aug 6, 2026

Changes in this version

+ const NoExpiry

+ const Version

Jul 30, 2026

Changes in this version

+ var ErrKeyNotFound = errors.New("capacitor: key not found")

Jul 30, 2026

Changes in this version

+ type BloomData struct

+ Filter []byte

+ type HLLData struct

+ Registers []byte

Jul 30, 2026

Changes in this version

type MsgType

+ const MsgSortedSetIncrement

Jul 30, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) GossipAddr() string

Jul 8, 2026

Changes in this version

type DeltaLog

+ Overflows uint64

type HLC

+ ClockSmashes uint64

type MetricsTracker

+ ActiveSubscriptions int64

+ BadgerWriteLat Stat

+ PeerConnectFailures uint64

+ ReplicationFailures uint64

Jul 8, 2026

Changes in this version

type DeltaLog

+ func (l *DeltaLog) PutEntriesRaw(entries [][]byte)

Jul 5, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) Publish(ctx context.Context, topic string, message any) error

+ func (f *Capacitor) Subscribe(ctx context.Context, topic string) (*Subscription, error)

type MsgType

+ const MsgPubSubPublish

+ type PubSubMessage struct

+ Payload []byte

+ Topic string

+ func (m *PubSubMessage) Scan(destPtr any) error

+ type PubSubPayload struct

+ Payload []byte

+ Topic string

+ type Subscription struct

+ Channel <-chan PubSubMessage

+ func (s *Subscription) Unsubscribe()

Jul 5, 2026

Changes in this version

+ type BloomPayload struct

+ Indices []uint32

+ type CMSPayload struct

+ Count int64

+ Element string

type Capacitor

+ func (f *Capacitor) BloomAdd(ctx context.Context, key string, element string) (bool, error)

+ func (f *Capacitor) BloomExists(ctx context.Context, key string, element string) (bool, error)

+ func (f *Capacitor) CMSIncrement(ctx context.Context, key string, element string, count int64) error

+ func (f *Capacitor) CMSQuery(ctx context.Context, key string, element string) (int64, error)

+ func (f *Capacitor) HLLAdd(ctx context.Context, key string, elements ...string) (bool, error)

+ func (f *Capacitor) HLLCount(ctx context.Context, key string) (int64, error)

+ type HLLPayload struct

+ Index uint32

+ Value byte

type MsgType

+ const MsgBloomAdd

+ const MsgCMSIncrement

+ const MsgHLLAdd

Jul 5, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) ListLeftPopScan(ctx context.Context, key string, destPtr any) (bool, error)

+ func (f *Capacitor) ListLeftPush(ctx context.Context, key string, value any) error

+ func (f *Capacitor) ListLen(ctx context.Context, key string) (int, error)

+ func (f *Capacitor) ListRangeScan(ctx context.Context, key string, start, stop int, destSlicePtr any) error

+ func (f *Capacitor) ListRightPopScan(ctx context.Context, key string, destPtr any) (bool, error)

+ func (f *Capacitor) ListRightPush(ctx context.Context, key string, value any) error

+ type ListElement struct

+ DeletedAt Timestamp

+ ID Timestamp

+ ParentID Timestamp

+ Value []byte

+ type ListPayload struct

+ DeletedAt Timestamp

+ ID Timestamp

+ ParentID Timestamp

+ Value []byte

type MsgType

+ const MsgListDelete

+ const MsgListInsert

Jul 5, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) NMapExists(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) NMapGetAll(ctx context.Context, key string) (map[string]any, error)

+ func (f *Capacitor) NMapGetAllScan(ctx context.Context, key string, destStructPtr any) (bool, error)

+ func (f *Capacitor) NMapGetExpiry(ctx context.Context, key, field string) (int64, bool, error)

+ func (f *Capacitor) NMapGetMScan(ctx context.Context, key string, fieldDestMap map[string]any) (int, error)

+ func (f *Capacitor) NMapGetScan(ctx context.Context, key, field string, destPtr any) (bool, error)

+ func (f *Capacitor) NMapGetTTL(ctx context.Context, key, field string) (time.Duration, bool, error)

+ func (f *Capacitor) NMapIncrementBy(ctx context.Context, key, field string, delta float64) (float64, error)

+ func (f *Capacitor) NMapKeysScan(ctx context.Context, key string, destSlicePtr any) error

+ func (f *Capacitor) NMapLen(ctx context.Context, key string) (int, error)

+ func (f *Capacitor) NMapRemove(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) NMapRemoveExpiry(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) NMapRemoveTTL(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) NMapSet(ctx context.Context, key, field string, value any, ttl time.Duration) (bool, error)

+ func (f *Capacitor) NMapSetExpiry(ctx context.Context, key, field string, expireTimeMs int64) (bool, error)

+ func (f *Capacitor) NMapSetTTL(ctx context.Context, key, field string, ttl time.Duration) (bool, error)

+ func (f *Capacitor) NMapValuesScan(ctx context.Context, key string, destSlicePtr any) error

type MsgType

+ const MsgNMapRemove

+ const MsgNMapSet

+ type NMapField struct

+ AddedAt Timestamp

+ ExpiresAt int64

+ RemovedAt Timestamp

+ Value []byte

+ type NMapPayload struct

+ ExpiresAt int64

+ Field string

+ Value []byte

Jul 5, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) MapExists(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) MapGetAll(ctx context.Context, key string) (map[string]string, error)

+ func (f *Capacitor) MapGetAllScan(ctx context.Context, key string, destStructPtr any) (bool, error)

+ func (f *Capacitor) MapGetExpiry(ctx context.Context, key, field string) (int64, bool, error)

+ func (f *Capacitor) MapGetMScan(ctx context.Context, key string, fieldDestMap map[string]any) (int, error)

+ func (f *Capacitor) MapGetScan(ctx context.Context, key, field string, destPtr any) (bool, error)

+ func (f *Capacitor) MapGetTTL(ctx context.Context, key, field string) (time.Duration, bool, error)

+ func (f *Capacitor) MapIncrementBy(ctx context.Context, key, field string, delta float64) (float64, error)

+ func (f *Capacitor) MapKeysScan(ctx context.Context, key string, destSlicePtr any) error

+ func (f *Capacitor) MapLen(ctx context.Context, key string) (int, error)

+ func (f *Capacitor) MapRemove(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) MapRemoveExpiry(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) MapRemoveTTL(ctx context.Context, key, field string) (bool, error)

+ func (f *Capacitor) MapSet(ctx context.Context, key, field string, value any, ttl time.Duration) (bool, error)

+ func (f *Capacitor) MapSetExpiry(ctx context.Context, key, field string, expireTimeMs int64) (bool, error)

+ func (f *Capacitor) MapSetTTL(ctx context.Context, key, field string, ttl time.Duration) (bool, error)

+ func (f *Capacitor) MapValuesScan(ctx context.Context, key string, destSlicePtr any) error

+ type MapField struct

+ AddedAt Timestamp

+ ExpiresAt int64

+ RemovedAt Timestamp

+ Value string

+ type MapPayload struct

+ ExpiresAt int64

+ Field string

+ Value string

type MsgType

+ const MsgMapRemove

+ const MsgMapSet

Jul 5, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) SortedSetRevRangeByScoreScan(ctx context.Context, key string, max, min float64, destSlicePtr any, ...) error

+ func (f *Capacitor) SortedSetRevRangeScan(ctx context.Context, key string, start, stop int64, destSlicePtr any, ...) error

Jul 4, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) SortedSetAdd(ctx context.Context, key string, score float64, member any) (bool, error)

+ func (f *Capacitor) SortedSetCard(ctx context.Context, key string) (int64, error)

+ func (f *Capacitor) SortedSetCount(ctx context.Context, key string, min, max float64) (int64, error)

+ func (f *Capacitor) SortedSetIncrementBy(ctx context.Context, key string, member any, delta float64) (float64, error)

+ func (f *Capacitor) SortedSetPopScan(ctx context.Context, key string, dest any, outScore *float64) (bool, error)

+ func (f *Capacitor) SortedSetRangeByScoreScan(ctx context.Context, key string, min, max float64, destSlicePtr any, ...) error

+ func (f *Capacitor) SortedSetRangeScan(ctx context.Context, key string, start, stop int64, destSlicePtr any, ...) error

+ func (f *Capacitor) SortedSetRank(ctx context.Context, key string, member any) (int64, error)

+ func (f *Capacitor) SortedSetRemove(ctx context.Context, key string, member any) (bool, error)

+ func (f *Capacitor) SortedSetScore(ctx context.Context, key string, member any) (float64, bool, error)

type MsgType

+ const MsgSortedSetAdd

+ const MsgSortedSetRemove

+ type SortedSetElement struct

+ AddedAt Timestamp

+ RemovedAt Timestamp

+ Score float64

Jul 3, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) SetAdd(ctx context.Context, key string, member any) (bool, error)

+ func (f *Capacitor) SetCard(ctx context.Context, key string) (int64, error)

+ func (f *Capacitor) SetIsMember(ctx context.Context, key string, member any) (bool, error)

+ func (f *Capacitor) SetMIsMember(ctx context.Context, key string, members ...any) ([]bool, error)

+ func (f *Capacitor) SetMembers(ctx context.Context, key string) ([]string, error)

+ func (f *Capacitor) SetMembersScan(ctx context.Context, key string, destSlicePtr any) error

+ func (f *Capacitor) SetMove(ctx context.Context, source string, destination string, member any) (bool, error)

+ func (f *Capacitor) SetPop(ctx context.Context, key string) (string, error)

+ func (f *Capacitor) SetPopScan(ctx context.Context, key string, dest any) (bool, error)

+ func (f *Capacitor) SetRandMember(ctx context.Context, key string) (string, error)

+ func (f *Capacitor) SetRandMemberScan(ctx context.Context, key string, dest any) (bool, error)

+ func (f *Capacitor) SetRemove(ctx context.Context, key string, member any) (bool, error)

type MsgType

+ const MsgSetAdd

+ const MsgSetRemove

+ type SetElement struct

+ AddedAt Timestamp

+ RemovedAt Timestamp

Jul 1, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) Delete(ctx context.Context, key string) error

type MsgType

+ const MsgDelete

Jun 30, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) Exists(ctx context.Context, key string) (bool, error)

type Config

+ DisableMetrics bool

Jun 30, 2026

Changes in this version

type Capacitor

+ func (f *Capacitor) GetScan(ctx context.Context, key string, dest any) error

Jun 30, 2026

Changes in this version

+ const DefaultMaxOffset

+ var ErrClockSmash = errors.New("HLC clock smash detected")

+ type Batch struct

+ Entries [][]byte

+ FromNode string

+ Handshake *Handshake

+ func (z *Batch) DecodeMsg(dc *msgp.Reader) (err error)

+ func (z *Batch) EncodeMsg(en *msgp.Writer) (err error)

+ func (z *Batch) MarshalMsg(b []byte) (o []byte, err error)

+ func (z *Batch) Msgsize() (s int)

+ func (z *Batch) UnmarshalMsg(bts []byte) (o []byte, err error)

+ type Capacitor struct

+ func New(cfg Config) (*Capacitor, error)

+ func (f *Capacitor) Close() error

+ func (f *Capacitor) Get(ctx context.Context, key string) (string, error)

+ func (f *Capacitor) GetCount(ctx context.Context, key string) (int64, error)

+ func (f *Capacitor) GetMetric(ctx context.Context, key string) (Metric, error)

+ func (f *Capacitor) GetMetrics() []Summary

+ func (f *Capacitor) Increment(ctx context.Context, key string) (int64, error)

+ func (f *Capacitor) IncrementBy(ctx context.Context, key string, delta int64) (int64, error)

+ func (f *Capacitor) IncrementMetric(ctx context.Context, key string, delta float64) (Metric, error)

+ func (f *Capacitor) IncrementMetricParallel(ctx context.Context, keys map[string]float64) (map[string]Metric, error)

+ func (f *Capacitor) IncrementParallel(ctx context.Context, keys []string) (map[string]int64, error)

+ func (f *Capacitor) IncrementSlidingWindow(ctx context.Context, key string, window time.Duration) (int64, error)

+ func (f *Capacitor) Set(ctx context.Context, key string, value any, ttl time.Duration) error

+ type Config struct

+ AdvertiseAddr string

+ AuthToken string

+ BindAddr string

+ BindPort int

+ DataPath string

+ LogSize uint64

+ Logger Logger

+ NodeID string

+ Peers []string

+ StreamPort int

+ TLSConfig *tls.Config

+ type DeltaLog struct

+ func NewDeltaLog(capacity uint64) *DeltaLog

+ func (l *DeltaLog) Append(entry LogEntry) uint64

+ func (l *DeltaLog) GetEntriesRaw(startSeq uint64, limit int, maxBytes int) [][]byte

+ func (l *DeltaLog) Head() uint64

+ type HLC struct

+ func NewHLC() *HLC

+ func (h *HLC) Now() Timestamp

+ func (h *HLC) SetMaxOffset(offset time.Duration)

+ func (h *HLC) Update(remote Timestamp) (Timestamp, error)

+ type Handshake struct

+ AuthToken string

+ LastSeenSeq uint64

+ func (z *Handshake) DecodeMsg(dc *msgp.Reader) (err error)

+ func (z *Handshake) UnmarshalMsg(bts []byte) (o []byte, err error)

+ func (z Handshake) EncodeMsg(en *msgp.Writer) (err error)

+ func (z Handshake) MarshalMsg(b []byte) (o []byte, err error)

+ func (z Handshake) Msgsize() (s int)

+ type LogEntry struct

+ BornAt int64

+ Delta float64

+ Key string

+ NodeID string

+ Op MsgType

+ Seq uint64

+ TS Timestamp

+ TTL int64

+ Value []byte

+ func (z *LogEntry) MarshalMsg(b []byte) (o []byte, err error)

+ func (z *LogEntry) Msgsize() (s int)

+ func (z *LogEntry) UnmarshalMsg(bts []byte) (o []byte, err error)

+ type Logger interface

+ Debug func(msg string, args ...any)

+ Error func(msg string, args ...any)

+ Info func(msg string, args ...any)

+ Warn func(msg string, args ...any)

+ type Message struct

+ Delta float64

+ Key string

+ NodeID string

+ TTL int64

+ Timestamp int64

+ Type MsgType

+ Value []byte

+ ValueObj any

+ func Decode(data []byte) (*Message, error)

+ func (m *Message) Encode() ([]byte, error)

+ func (z *Message) DecodeMsg(dc *msgp.Reader) (err error)

+ func (z *Message) EncodeMsg(en *msgp.Writer) (err error)

+ func (z *Message) MarshalMsg(b []byte) (o []byte, err error)

+ func (z *Message) Msgsize() (s int)

+ func (z *Message) UnmarshalMsg(bts []byte) (o []byte, err error)

+ type Metric struct

+ Count int64

+ Sum float64

+ type MetricsTracker struct

+ GetLat Stat

+ IncrLat Stat

+ PeakAlloc uint64

+ PeakHeapAlloc uint64

+ PeakSys uint64

+ ReplicateLat Stat

+ SetLat Stat

+ func NewMetricsTracker() *MetricsTracker

+ func (m *MetricsTracker) GetSummary() []Summary

+ func (m *MetricsTracker) Stop()

+ type MsgType byte

+ const MsgIncr

+ const MsgMetric

+ const MsgSet

+ const MsgWindow

+ func (z *MsgType) DecodeMsg(dc *msgp.Reader) (err error)

+ func (z *MsgType) UnmarshalMsg(bts []byte) (o []byte, err error)

+ func (z MsgType) EncodeMsg(en *msgp.Writer) (err error)

+ func (z MsgType) MarshalMsg(b []byte) (o []byte, err error)

+ func (z MsgType) Msgsize() (s int)

+ type Stat struct

+ Count int64

+ Max int64

+ Sum int64

+ func (s *Stat) Record(duration time.Duration)

+ type StreamClient struct

+ func NewStreamClient(tlsConfig *tls.Config, authToken string) *StreamClient

+ func (c *StreamClient) Close()

+ func (c *StreamClient) CloseConn(nodeID string)

+ func (c *StreamClient) SendBatch(ctx context.Context, nodeID string, addr string, batch Batch, ...) error

+ type StreamServer struct

+ func NewStreamServer(cp *Capacitor, addr string, tlsConfig *tls.Config) (*StreamServer, error)

+ func (s *StreamServer) Start()

+ func (s *StreamServer) Stop()

+ type Summary struct

+ Average time.Duration

+ Count int64

+ Metric string

+ Peak time.Duration

+ PeakHeapMB float64

+ PeakMemMB float64

+ type Timestamp struct

+ Logical int32

+ Physical int64

+ func (t Timestamp) After(other Timestamp) bool

+ func (t Timestamp) GreaterOrEqual(other Timestamp) bool

+ func (t Timestamp) String() string

+ func (z *Timestamp) DecodeMsg(dc *msgp.Reader) (err error)

+ func (z *Timestamp) UnmarshalMsg(bts []byte) (o []byte, err error)

+ func (z Timestamp) EncodeMsg(en *msgp.Writer) (err error)

+ func (z Timestamp) MarshalMsg(b []byte) (o []byte, err error)

+ func (z Timestamp) Msgsize() (s int)