wal

package

v1.19.9 Latest Latest Go to latest Published: Oct 15, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cilium/cilium

Links

Open Source Insights

Documentation ¶

Index ¶

func Read[T Event](logPath string, unmarshaller func(data []byte) (T, error)) (iter.Seq2[T, error], error)
type BatchError
- func (be BatchError) Error() string
type BatchErrors
- func (be BatchErrors) Error() string
type Event
type Writer
- func NewWriter[T Event](logPath string) (*Writer[T], error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Read ¶

func Read[T Event](logPath string, unmarshaller func(data []byte) (T, error)) (iter.Seq2[T, error], error)

Read reads all events from the WAL at logPath using the provided unmarshaller function.

Types ¶

type BatchError ¶

type BatchError struct {
	Index int
	Err   error
}

func (BatchError) Error ¶

func (be BatchError) Error() string

type BatchErrors ¶

type BatchErrors []BatchError

func (BatchErrors) Error ¶

func (be BatchErrors) Error() string

type Event ¶

type Event interface {
	encoding.BinaryMarshaler
}

type Writer ¶

type Writer[T Event] struct {
	// contains filtered or unexported fields
}

func NewWriter ¶

func NewWriter[T Event](logPath string) (*Writer[T], error)

NewWriter creates a new WAL writer for events of type T at the specified logPath. The log file is created if it does not exist. The log is not truncated if it exists and thus it's recommended to [Compact] early.

func (*Writer[T]) Close ¶

func (w *Writer[T]) Close() error

func (*Writer[T]) Compact ¶

func (w *Writer[T]) Compact(all iter.Seq[T]) error

Compact rewrites the WAL to contain only the provided events, removing any redundant or obsolete entries.

func (*Writer[T]) Write ¶

func (w *Writer[T]) Write(e ...T) error

Write appends an event to the WAL. Data is flushed to disk before returning.

Source Files ¶

View all Source files

wal.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL