Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

effects

package

Go to main page

Versions in this module

v0

v0.2.1

May 12, 2026

v0.2.0

May 6, 2026

Changes in this version

+ func MarshalEffect(eff *pb.Effect) ([]byte, error)

+ func UnmarshalEffect(data []byte, eff *pb.Effect) error

v0.1.4

May 4, 2026

v0.1.3

May 4, 2026

v0.1.2

May 4, 2026

v0.1.1

May 4, 2026

v0.1.0

May 4, 2026

v0.0.8

May 4, 2026

v0.0.7

May 4, 2026

v0.0.6

Apr 29, 2026

v0.0.5

Apr 29, 2026

v0.0.4

Apr 29, 2026

Changes in this version

+ const DefaultSerializationThreshold

+ const FlushKey

+ var ErrBootstrapIncomplete = errors.New("bootstrap incomplete: some peers unreachable")

+ var ErrRegionPartitioned = errors.New("region partitioned: not all same-region peers are reachable")

+ var ErrTxnAborted = errors.New("transaction aborted")

+ func ComputeForkChoiceHash(nodeID proto.NodeID, hlc *timestamppb.Timestamp) []byte

+ func ForkChoiceLess(a, b []byte) bool

+ func GenerateKeyPair() ([]byte, []byte, error)

+ func Merge2(a, b *pb.ReducedEffect) *pb.ReducedEffect

+ func MergeN(branches []*pb.ReducedEffect) *pb.ReducedEffect

+ func ReduceBranch(effects []*pb.Effect) *pb.ReducedEffect

+ func ReduceChain(seed *pb.ReducedEffect, effects []*pb.Effect) *pb.ReducedEffect

+ type AnnotatedNode struct

+ Concurrent bool

+ Node *DAGNode

+ type Broadcaster interface

+ AllRegionPeersReachable func() bool

+ Broadcast func(notify *pb.OffsetNotify)

+ BroadcastWithData func(notify *pb.OffsetNotify, effectData []byte)

+ Fetch func(ref *pb.EffectRef) ([]byte, error)

+ FetchFromAny func(ref *pb.EffectRef) ([]byte, error)

+ ForwardTransaction func(ctx context.Context, targetNodeID pb.NodeID, tx *pb.ForwardedTransaction) (*pb.ForwardedResponse, error)

+ InMajorityPartition func() bool

+ PeerIDs func() []pb.NodeID

+ Replicate func(notify *pb.OffsetNotify, wireData []byte) error

+ ReplicateTo func(notify *pb.OffsetNotify, wireData []byte, targetNodeID pb.NodeID) ([]*pb.NackNotify, error)

+ SendNack func(nack *pb.NackNotify, targetNodeID pb.NodeID)

+ type BunnyStorage struct

+ func NewBunnyStorage(uploadEndpoint, cdnEndpoint, accessKey string) *BunnyStorage

+ func (b *BunnyStorage) Download(ctx context.Context, path string) ([]byte, error)

+ func (b *BunnyStorage) Upload(ctx context.Context, path string, data []byte) error

+ type Context struct

+ func (c *Context) Abort()

+ func (c *Context) BeginTx()

+ func (c *Context) CheckWatches() bool

+ func (c *Context) ClearWatches()

+ func (c *Context) Emit(eff *pb.Effect, snapshotTips ...[]Tip) error

+ func (c *Context) Flush() error

+ func (c *Context) GetSnapshot(key string) (*pb.ReducedEffect, []Tip, error)

+ func (c *Context) PendingKeys() []string

+ func (c *Context) RestoreSavepoint(sp *ContextSavepoint)

+ func (c *Context) SetTraceCtx(ctx context.Context)

+ func (c *Context) TakeSavepoint() *ContextSavepoint

+ func (c *Context) TraceCtx() context.Context

+ func (c *Context) Watch(key string)

+ type ContextSavepoint struct

+ type DAG struct

+ func BuildDAG(nodes []*DAGNode) *DAG

+ func (d *DAG) AreConcurrent(a, b *DAGNode) bool

+ func (d *DAG) Children(n *DAGNode) []*DAGNode

+ func (d *DAG) ConnectedComponents() [][]*DAGNode

+ func (d *DAG) DescendantsOf(n *DAGNode) []*DAGNode

+ func (d *DAG) ExtractBranches(fork *DAGNode) [][]*DAGNode

+ func (d *DAG) FindLCA(tips []*DAGNode) *DAGNode

+ func (d *DAG) Parent(n *DAGNode) *DAGNode

+ func (d *DAG) Parents(n *DAGNode) []*DAGNode

+ func (d *DAG) PathToTip(fork *DAGNode, tp *DAGNode) []*DAGNode

+ func (d *DAG) Restrict(offsets map[Tip]bool) *DAG

+ func (d *DAG) Roots() []*DAGNode

+ func (d *DAG) Tips() []*DAGNode

+ func (d *DAG) TopologicalSort() []AnnotatedNode

+ type DAGNode struct

+ Effect *pb.Effect

+ Offset Tip

+ type Encryptor struct

+ func NewEncryptor(pubKeyBytes, privKeyBytes []byte) (*Encryptor, error)

+ func (enc *Encryptor) OpenAndDecompress(sealed, info []byte) ([]byte, error)

+ func (enc *Encryptor) SealAndCompress(plaintext, info []byte) ([]byte, error)

+ type Engine struct

+ OnFlushAll func()

+ OnKeyDataAdded func(key string)

+ OnKeyDeleted func(key string)

+ func NewEngine(cfg EngineConfig) *Engine

+ func NewTestEngine() *Engine

+ func (e *Engine) CheckSerializationLeader(key string) *pb.NodeID

+ func (e *Engine) Close() error

+ func (e *Engine) EffectCache() *clox.CloxCache[Tip, *pb.Effect]

+ func (e *Engine) FlushIndex()

+ func (e *Engine) Forward(commandName string, args [][]byte, keys []string, username string) []byte

+ func (e *Engine) ForwardExec(commands []ForwardCommand, watchedKeys []string, username string) []byte

+ func (e *Engine) GetLock(key string) *sync.Mutex

+ func (e *Engine) GetSnapshot(key string) (*pb.ReducedEffect, []Tip, int, error)

+ func (e *Engine) HandleNack(nack *pb.NackNotify) error

+ func (e *Engine) HandleRemote(notify *pb.OffsetNotify) ([]*pb.NackNotify, error)

+ func (e *Engine) KeyCount() int64

+ func (e *Engine) MatchKeys(pattern string) []string

+ func (e *Engine) NewContext() *Context

+ func (e *Engine) NodeID() pb.NodeID

+ func (e *Engine) ReconvergeAllKeys()

+ func (e *Engine) RecordSerializationActivity(key string)

+ func (e *Engine) ScanKeys(after string, pattern string, fn func(key string) bool)

+ func (e *Engine) SetBroadcaster(b Broadcaster)

+ func (e *Engine) SetRTTProvider(p PeerRTTProvider)

+ func (e *Engine) StartAntiEntropy(interval time.Duration)

+ func (e *Engine) UpdateSafetyRules(defaultMode SafetyMode, rules []KeyRangeRule)

+ type EngineConfig struct

+ Broadcaster Broadcaster

+ Cache StateCache

+ DefaultMode SafetyMode

+ HorizonTimeout time.Duration

+ Index keytrie.KeyIndex

+ KeyRangeRules []KeyRangeRule

+ MemoryLimit int64

+ MemoryLimitPercent float64

+ NodeID pb.NodeID

+ RTTProvider PeerRTTProvider

+ func (c *EngineConfig) ModeForKey(key string) SafetyMode

+ type ForwardCommand struct

+ Args [][]byte

+ Keys []string

+ Name string

+ type HorizonSet struct

+ func (h *HorizonSet) Add(txnID string, bindOffset Tip, bind *pb.TransactionalBindEffect, ...)

+ func (h *HorizonSet) IsInvisible(txnID string) bool

+ func (h *HorizonSet) MakeVisible(txnID string)

+ func (h *HorizonSet) StopAll()

+ type KeyRangeRule struct

+ Mode SafetyMode

+ Pattern string

+ type MemoryStorage struct

+ func NewMemoryStorage() *MemoryStorage

+ func (m *MemoryStorage) Download(_ context.Context, path string) ([]byte, error)

+ func (m *MemoryStorage) Keys() []string

+ func (m *MemoryStorage) Upload(_ context.Context, path string, data []byte) error

+ type ObjectStorage interface

+ Download func(ctx context.Context, path string) ([]byte, error)

+ Upload func(ctx context.Context, path string, data []byte) error

+ type PeerRTTProvider interface

+ AlivePeerIDs func() []pb.NodeID

+ GetRTT func(nodeID pb.NodeID) time.Duration

+ type SafetyMode int

+ const SafeMode

+ const UnsafeMode

+ type StateCache interface

+ Evict func(key string)

+ Get func(key string) (*pb.ReducedEffect, bool)

+ Put func(key string, value *pb.ReducedEffect)

+ type Tip = keytrie.EffectRef

v0.0.3

Apr 29, 2026

v0.0.2

Apr 29, 2026

v0.0.1

Apr 29, 2026