journal

Dec 19, 2025

Changes in this version

type Options

+ TrashPath string

+ VeryVerbose bool

Sep 18, 2025

Changes in this version

type Filter

+ Latest bool

+ Limit int

Sep 3, 2025

Changes in this version

+ func MergedRecords(journals map[uint64]*Journal, filter Filter, fail func(error)) iter.Seq[RecordWithSource]

+ type RecordWithSource struct

+ Source uint64

Mar 21, 2025

Changes in this version

+ var ErrMissingSealKey = errors.New("missing seal key")

+ func TimeToStr(t time.Time) string

type Journal

+ func (j *Journal) CanSeal() bool

+ func (j *Journal) Seal(ctx context.Context) (Segment, error)

+ func (j *Journal) SealAndTrimAll(ctx context.Context) (int, error)

+ func (j *Journal) SealAndTrimOnce(ctx context.Context) (int, error)

+ func (j *Journal) Trim() (Segment, error)

type Options

+ SealKeys []*sealer.Key

+ SealOpts sealer.SealOptions

type Set

+ func (set *Set) Autocommit(ctx context.Context) int

+ func (set *Set) Autoseal(ctx context.Context) int

type SetOptions

+ AutosealDelay time.Duration

+ AutosealEnabled bool

type Status

+ func (s Status) CanSeal() bool

Feb 25, 2025

Changes in this version

type Meta

+ func (meta Meta) IsNonZero() bool

type Segment

+ func (seg Segment) IsNonZero() bool

type Summary

+ LastUncommitted Meta

+ func (s *Summary) UncommittedCount() int

Feb 25, 2025

Changes in this version

+ var ErrInvalidTimestamp = errors.New("invalid timestamp")

+ func ParseTime(s string) (uint64, error)

type Journal

+ func (j *Journal) QuickSummary() (Summary, error)

+ func (j *Journal) Summary() (Summary, error)

+ type Meta struct

+ ID uint64

+ Timestamp uint64

+ func (meta *Meta) IsZero() bool

+ func (meta *Meta) Time() time.Time

type Segment

+ func (seg Segment) FirstRecord() Meta

+ func (seg Segment) RecordNumber() uint64

+ func (seg Segment) SegmentNumber() uint64

+ func (seg Segment) Time() time.Time

+ func (seg Segment) Timestamp() uint64

+ type Summary struct

+ FirstSealedSegment Segment

+ FirstUnsealedSegment Segment

+ LastCommitted Meta

+ LastRaw Meta

+ LastSealedSegment Segment

+ LastUnsealedSegment Segment

+ SegmentCount int

+ func (s *Summary) FirstRecord() Meta

Feb 24, 2025

Changes in this version

+ type AutocommitOptions struct

+ Interval time.Duration

type Journal

+ func (j *Journal) Autocommit(now uint64) (bool, error)

type Options

+ Autocommit AutocommitOptions

Feb 24, 2025

Changes in this version

+ const DefaultMaxFileSize

+ var ErrIncompatible = fmt.Errorf("incompatible journal")

+ var ErrInternal = errors.New("journal: internal error")

+ var ErrUnsupportedVersion = fmt.Errorf("unsupported journal version")

+ func ToTime(ts uint64) time.Time

+ func ToTimestamp(t time.Time) uint64

+ type AutorotateOptions struct

+ Interval time.Duration

+ type Cursor struct

+ func (c *Cursor) Close()

+ func (c *Cursor) Err() error

+ func (c *Cursor) Next() bool

+ type Filter struct

+ MaxRecordID uint64

+ MaxTimestamp uint64

+ MinRecordID uint64

+ MinTimestamp uint64

+ type Journal struct

+ func New(dir string, o Options) *Journal

+ func (j *Journal) Autorotate(now uint64) (bool, error)

+ func (j *Journal) Commit() error

+ func (j *Journal) FindSegments(filter Filter) ([]Segment, error)

+ func (j *Journal) FinishWriting() error

+ func (j *Journal) Initialize() error

+ func (j *Journal) Now() uint64

+ func (j *Journal) Read(filter Filter) *Cursor

+ func (j *Journal) Records(filter Filter, fail func(error)) iter.Seq[Record]

+ func (j *Journal) Rotate() error

+ func (j *Journal) SegmentCount() (int, error)

+ func (j *Journal) StartWriting()

+ func (j *Journal) String() string

+ func (j *Journal) WriteRecord(timestamp uint64, data []byte) error

+ type Options struct

+ Autorotate AutorotateOptions

+ Context context.Context

+ DebugName string

+ FileName string

+ JournalInvariant [32]byte

+ Logger *slog.Logger

+ MaxFileSize int64

+ Now func() time.Time

+ OnChange func()

+ SegmentInvariant [32]byte

+ Verbose bool

+ type Record struct

+ Data []byte

+ ID uint64

+ Timestamp uint64

+ func (rec *Record) Time() time.Time

+ type Segment struct

+ func (seg Segment) IsZero() bool

+ func (seg Segment) String() string

+ type Set struct

+ func NewSet(opt SetOptions) *Set

+ func (set *Set) Add(j *Journal)

+ func (set *Set) Journals() []*Journal

+ func (set *Set) Process(ctx context.Context) int

+ func (set *Set) Remove(j *Journal)

+ func (set *Set) StartBackground(ctx context.Context) *SetRunner

+ type SetOptions struct

+ Logger *slog.Logger

+ Now func() time.Time

+ type SetRunner struct

+ func (runner *SetRunner) Close()

+ type Status uint8

+ const Draft

+ const Finalized

+ const Invalid

+ const Sealed

+ func (s Status) IsDraft() bool

+ func (s Status) IsSealed() bool