README
¶
stuffedio
Go log implementation using Consistent-Overhead Word Stuffing (self-synchronizing journal). Based on the excellent writeup by Paul Khuong: https://www.pvk.ca/Blog/2021/01/11/stuff-your-logs/.
The stuffedio package is simple: it implements COWS/COBS as described in the
above article, allowing you to wrap a writer and write stuffed log entries, or
wrap a reader and decode them, skipping corruption as needed, or as your use
case allows.
See examples in the code documentation for basic use.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
stuffedcat
Command stuffedcat allows you to cat stuffedio logs, either record or ordered IO.
|
Command stuffedcat allows you to cat stuffedio logs, either record or ordered IO. |
|
Package orderedio implements an ordered log with explicit ordinals over top of a record Encoder/Decoder.
|
Package orderedio implements an ordered log with explicit ordinals over top of a record Encoder/Decoder. |
|
Package recordio implements a straightforward self-synchronizing log using consistent-overhead word stuffing (yes, COWS) as described in Paul Khuong's https://www.pvk.ca/Blog/2021/01/11/stuff-your-logs/.
|
Package recordio implements a straightforward self-synchronizing log using consistent-overhead word stuffing (yes, COWS) as described in Paul Khuong's https://www.pvk.ca/Blog/2021/01/11/stuff-your-logs/. |
|
Package wal implements a full write-ahead log over a directory of files, including snapshot management, reply iterators, and rotating log writers.
|
Package wal implements a full write-ahead log over a directory of files, including snapshot management, reply iterators, and rotating log writers. |
Click to show internal directories.
Click to hide internal directories.