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

s3lect

package module

Go to main page

Versions in this module

v1

v1.0.2

Feb 6, 2026

Changes in this version

type ElectorConfig

+ PeerHealthPath string

v1.0.1

Nov 24, 2025

Changes in this version

type Elector

+ WaitForNextElection func(ctx context.Context, since time.Time) (*LeadershipStatus, error)

type S3Elector

+ func (e *S3Elector) WaitForNextElection(ctx context.Context, since time.Time) (*LeadershipStatus, error)

v1.0.0

Nov 13, 2025

Changes in this version

+ var ErrStorageNotFound = errors.New("object not found")

+ var ErrStoragePrecondition = errors.New("precondition failed")

+ func NewLeadershipHandler(elector Elector, logger *slog.Logger) http.HandlerFunc

+ type Elector interface

+ EnablePeerMode func(caCert []byte) error

+ GetConfig func() *ElectorConfig

+ GetLeadershipStatus func() *LeadershipStatus

+ IsLeader func() bool

+ LeaderID func() string

+ Start func(ctx context.Context) error

+ Stop func() error

+ UpdateConfig func(newConfig ElectorConfig) error

+ WaitForLeadership func(ctx context.Context) error

+ type ElectorConfig struct

+ FrequentInterval time.Duration

+ InfrequentInterval time.Duration

+ LeaderTimeout time.Duration

+ LockfilePath string

+ OnAcquireLeadership func(ctx context.Context) error

+ OnLoseLeadership func(ctx context.Context) error

+ PeerCACert []byte

+ PeerMode bool

+ PeerTimeout time.Duration

+ ServerAddr string

+ ServerID string

+ func (c *ElectorConfig) Validate() error

+ type HealthServer struct

+ func NewHealthServer(config HealthServerConfig) (*HealthServer, error)

+ func (hs *HealthServer) Start(ctx context.Context) error

+ func (hs *HealthServer) Stop(ctx context.Context) error

+ type HealthServerConfig struct

+ BindAddress string

+ Certificate tls.Certificate

+ Elector Elector

+ Logger *slog.Logger

+ type LeaderRecord struct

+ LastUpdated time.Time

+ LeaderAddr string

+ LeaderID string

+ Metadata LeaderRecordMetadata

+ type LeaderRecordMetadata struct

+ ETag string

+ type LeadershipStatus struct

+ ConsecutiveFails int

+ IsLeader bool

+ LastElectionTime time.Time

+ LeaderAddr string

+ LeaderID string

+ LeaderLastSeen time.Time

+ LockfilePath string

+ ServerID string

+ type MockStorage struct

+ func NewMock() *MockStorage

+ func NewMockStorage(baseDir string) (*MockStorage, error)

+ func (m *MockStorage) Cleanup() error

+ func (m *MockStorage) Get(ctx context.Context, key string) ([]byte, string, error)

+ func (m *MockStorage) PutIfMatch(ctx context.Context, key string, data []byte, etag string) error

+ type S3Elector struct

+ func NewS3Elector(opts S3ElectorOptions) (*S3Elector, error)

+ func (e *S3Elector) EnablePeerMode(caCert []byte) error

+ func (e *S3Elector) GetConfig() *ElectorConfig

+ func (e *S3Elector) GetLeadershipStatus() *LeadershipStatus

+ func (e *S3Elector) IsLeader() bool

+ func (e *S3Elector) LeaderID() string

+ func (e *S3Elector) Start(ctx context.Context) error

+ func (e *S3Elector) Stop() error

+ func (e *S3Elector) UpdateConfig(newConfig ElectorConfig) error

+ func (e *S3Elector) WaitForLeadership(ctx context.Context) error

+ type S3ElectorOptions struct

+ Config *ElectorConfig

+ Logger *slog.Logger

+ Storage Storage

+ type Storage interface

+ Get func(ctx context.Context, key string) (data []byte, etag string, err error)

+ PutIfMatch func(ctx context.Context, key string, data []byte, etag string) error