kiroku

Oct 17, 2023

Changes in this version

type Filename

+ CreatedAt int64

+ Filetype Type

+ Name string

Oct 17, 2023

Changes in this version

type Filename

+ func ParseFilename(filename string) (parsed Filename, err error)

Sep 29, 2023

Changes in this version

type Options

+ OnResume func()

Sep 29, 2023

Changes in this version

type Options

+ ConsumerFileLimit int64

Aug 23, 2023

Changes in this version

+ const ErrConsumerNilSource

+ const ErrConsumerSnapshot

+ const ErrConsumerTransaction

+ var ErrEmptyBlock = errors.New("invalid block, cannot be empty")

+ func NewOneShotConsumer(opts Options, src Source, onUpdate UpdateFunc) (err error)

+ func NewOneShotConsumerWithContext(ctx context.Context, opts Options, src Source, onUpdate UpdateFunc) (err error)

+ type Consumer struct

+ func NewConsumer(opts Options, src Source, onUpdate UpdateFunc) (mp *Consumer, err error)

+ func NewConsumerWithContext(ctx context.Context, opts Options, src Source, onUpdate UpdateFunc) (c *Consumer, err error)

+ func (c *Consumer) Close() (err error)

+ func (c *Consumer) Meta() (meta Meta, err error)

+ type Filename struct

+ func (f Filename) String() string

+ type IOSource struct

+ func NewIOSource(dir string) (ip *IOSource, err error)

+ func (i *IOSource) Export(ctx context.Context, filename string, r io.Reader) (newFilename string, err error)

+ func (i *IOSource) Get(ctx context.Context, filename string, fn func(io.Reader) error) (err error)

+ func (i *IOSource) GetNext(ctx context.Context, prefix, lastFilename string) (filename string, err error)

+ func (i *IOSource) Import(ctx context.Context, filename string, w io.Writer) (err error)

type Meta

+ LastProcessedTimestamp int64

+ LastProcessedType Type

+ func (m *Meta) IsEmpty() bool

type Options

+ OnError func(err error)

+ OnLog func(message string)

type Producer

+ func (p *Producer) Meta() (meta Meta, err error)

+ func (p *Producer) Snapshot(fn func(*Snapshot) error) (err error)

type Transaction

+ func (t *Transaction) Write(value []byte) (err error)

type Type

+ const TypeChunk

+ const TypeInvalid

+ const TypeSnapshot

+ const TypeTemporary

+ func (t *Type) UnmarshalJSON(bs []byte) (err error)

+ func (t Type) MarshalJSON() (bs []byte, err error)

+ type UpdateFunc func(Type, *Reader) error

type Writer

+ func (w *Writer) Write(value Block) (err error)

Jul 26, 2023

Changes in this version

+ const DefaultBatchDuration

+ type BatchFn func(*Transaction)

type Options

+ BatchDuration time.Duration

+ type Producer struct

+ func NewProducer(o Options, src Source) (kp *Producer, err error)

+ func NewProducerWithContext(ctx context.Context, o Options, src Source) (pp *Producer, err error)

+ func (p *Producer) Batch(fn BatchFn) (err error)

+ func (p *Producer) BatchBlock(typ Type, key []byte, value []byte) (err error)

+ func (p *Producer) Close() (err error)

+ func (p *Producer) Transaction(fn TransactionFn) (err error)

+ type TransactionFn func(*Transaction) error

Jul 13, 2023

Changes in this version

+ const DefaultErrorDelay

type Options

+ ErrorDelay time.Duration

+ RangeEnd time.Time

+ RangeStart time.Time

Jun 30, 2023

Changes in this version

type Options

+ OnUpdate func(*Reader)

Jun 28, 2023

Changes in this version

type Options

+ IsMirror bool

Jun 23, 2023

Changes in this version

type Options

+ func (o *Options) FullName() string

Jun 23, 2023

Changes in this version

type Options

+ Namespace string

Jun 22, 2023

Changes in this version

+ func GenerateFilename(name, kind string, timestamp int64) string

Dec 1, 2021

Changes in this version

+ type NOOP struct

+ func (n *NOOP) Export(ctx context.Context, filename string, r io.Reader) error

+ func (n *NOOP) Get(ctx context.Context, filename string, fn func(io.Reader) error) error

+ func (n *NOOP) GetNext(ctx context.Context, prefix, lastFilename string) (filename string, err error)

+ func (n *NOOP) Import(ctx context.Context, filename string, w io.Writer) error

Nov 24, 2021

Changes in this version

+ const ErrMirrorNilSource

+ const ErrMirrorSnapshot

+ const ErrMirrorTransaction

Nov 19, 2021

Changes in this version

type Transaction

+ func (t *Transaction) Meta() (m Meta)

Oct 21, 2021

Changes in this version

type Options

+ AvoidImportOnInit bool

Oct 12, 2021

Changes in this version

type Source

+ Get func(ctx context.Context, filename string, fn func(io.Reader) error) error

Oct 12, 2021

Changes in this version

type Source

+ GetLastSnapshot func(ctx context.Context, prefix string) (filename string, err error)

Oct 12, 2021

Changes in this version

+ type Source interface

+ Export func(filename string, r io.Reader) error

+ GetNext func(ctx context.Context, prefix, lastFilename string) (filename string, err error)

+ Import func(ctx context.Context, filename string, w io.Writer) (err error)

Sep 14, 2021

Changes in this version

+ type File interface

Sep 9, 2021

Changes in this version

+ type Ledger interface

+ Close func() (err error)

+ Filename func() (filename string, err error)

+ Meta func() (m Meta, err error)

+ Snapshot func(fn func(*Snapshot) error) (err error)

+ Transaction func(fn func(*Transaction) error) (err error)

type Mirror

+ func (m *Mirror) Snapshot(fn func(*Snapshot) error) (err error)

+ func (m *Mirror) Transaction(fn func(*Transaction) error) (err error)

type Options

+ EndOfResultsDelay time.Duration

Sep 8, 2021

Changes in this version

type Mirror

+ func (m *Mirror) Channel() <-chan struct{}

Sep 6, 2021

Changes in this version

+ const DefaultEndOfResultsDelay

+ const ErrEmptyDirectory

+ const ErrEmptyName

+ type Exporter interface

+ Export func(filename string, r io.Reader) error

+ type Importer interface

+ GetNext func(ctx context.Context, prefix, lastFilename string) (filename string, err error)

+ Import func(ctx context.Context, filename string, w io.Writer) (err error)

+ type Mirror struct

+ func NewMirror(opts MirrorOptions, i Importer) (mp *Mirror, err error)

+ func NewMirrorWithContext(ctx context.Context, opts MirrorOptions, i Importer) (mp *Mirror, err error)

+ func (m *Mirror) Close() (err error)

+ func (m *Mirror) Filename() (filename string, err error)

+ func (m *Mirror) Meta() (meta Meta, err error)

+ type MirrorOptions struct

+ EndOfResultsDelay time.Duration

+ OnImport Processor

+ func MakeMirrorOptions(dir, name string, onImport Processor) (o MirrorOptions)

+ func (m *MirrorOptions) Validate() (err error)

type Options

+ AvoidExportOnClose bool

+ Dir string

+ Name string

+ func MakeOptions(dir, name string) (o Options)

+ func (o *Options) Validate() (err error)

Mar 5, 2021

Changes in this version

type Writer

+ func (w *Writer) Close() (err error)

Mar 5, 2021

Changes in this version

type Writer

+ func (w *Writer) Filename() string

Mar 3, 2021

Changes in this version

type Reader

+ func (r *Reader) ReadSeeker() io.ReadSeeker

Mar 3, 2021

Changes in this version

type Writer

+ func (w *Writer) Meta() Meta

Feb 28, 2021

Changes in this version

+ func Read(filename string, p Processor) (err error)

+ type Block struct

+ Key []byte

+ Type Type

+ Value []byte

+ func (b *Block) MarshalEnkodo(enc *enkodo.Encoder) (err error)

+ func (b *Block) UnmarshalEnkodo(dec *enkodo.Decoder) (err error)

+ type Kiroku struct

+ func New(dir, name string, p Processor, o *Options) (kp *Kiroku, err error)

+ func NewWithContext(ctx context.Context, dir, name string, p Processor, o *Options) (kp *Kiroku, err error)

+ func (k *Kiroku) Close() (err error)

+ func (k *Kiroku) Filename() (filename string, err error)

+ func (k *Kiroku) Meta() (m Meta, err error)

+ func (k *Kiroku) Snapshot(fn func(*Snapshot) error) (err error)

+ func (k *Kiroku) Transaction(fn func(*Transaction) error) (err error)

+ type Meta struct

+ BlockCount int64

+ CreatedAt int64

+ CurrentIndex uint64

+ LastSnapshotAt int64

+ TotalBlockSize int64

+ type Options struct

+ AvoidMergeOnClose bool

+ AvoidMergeOnInit bool

+ AvoidProcessOnClose bool

+ AvoidProcessOnInit bool

+ type Processor func(*Reader) error

+ type Reader struct

+ func NewReader(rs io.ReadSeeker) (rp *Reader, err error)

+ func (r *Reader) Copy(destination io.Writer) (n int64, err error)

+ func (r *Reader) CopyBlocks(destination io.Writer) (n int64, err error)

+ func (r *Reader) ForEach(seek int64, fn func(*Block) error) (err error)

+ func (r *Reader) Meta() Meta

+ type Snapshot struct

+ func (s *Snapshot) Write(key, value []byte) (err error)

+ type Transaction struct

+ func (t *Transaction) AddBlock(typ Type, key, value []byte) (err error)

+ func (t *Transaction) GetIndex() (index uint64, err error)

+ func (t *Transaction) NextIndex() (index uint64, err error)

+ func (t *Transaction) SetIndex(index uint64) (err error)

+ type Type uint8

+ const TypeComment

+ const TypeDeleteAction

+ const TypeUnset

+ const TypeWriteAction

+ func (t Type) String() string

+ func (t Type) Validate() (err error)

+ type Writer struct

+ func NewWriter(dir, name string) (wp *Writer, err error)

+ func NewWriterWithFile(f *os.File) (wp *Writer, err error)

+ func (w *Writer) AddBlock(t Type, key, value []byte) (err error)

+ func (w *Writer) GetIndex() (index uint64, err error)

+ func (w *Writer) Merge(r *Reader) (err error)

+ func (w *Writer) NextIndex() (index uint64, err error)

+ func (w *Writer) SetIndex(index uint64) (err error)