Categorygithub.com/elastic/go-txfile
modulepackage
0.0.8
Repository: https://github.com/elastic/go-txfile.git
Documentation: pkg.go.dev

# README

txfile

# Packages

No description provided by the author
No description provided by the author
Package txerr provides common functions for querying and formatting errors generated by txfile.
Package txfiletest provides utilities for testing on top of txfile.

# Functions

Open opens or creates a new transactional file.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
can not create file.
No description provided by the author
No description provided by the author
FlagUnboundMaxSize configures the file max size to be unbound.
FlagUpdMaxSize updates the file max size setting.
FlagWaitLock instructs the open function to block until the file lock could be acquired.
failed to initialize from file.
internal error.
configuration error.
invalid file size.
meta page invalid.
invalid operation.
page id out of bounds.
invalid parameter.
No description provided by the author
No description provided by the author
No description provided by the author
no error.
No description provided by the author
No description provided by the author
out of memory.
No description provided by the author
SyncData prefers fdatasync if available.
SyncDefault lets the implementation choose the default syncing mode.
SyncFull enforces fsync/or similar.
SyncNone disable syncing.
transaction failed during commit.
transaction failed.
finished transaction.
readonly transaction.
transaction failed during rollback.

# Structs

Error is the actual error type returned by all functions/methods within the txfile package.
File provides transactional support to pages of a file.
FileStats reports the current file state like version and allocated/free space.
Options provides common file options used when opening or creating a file.
Page provides access to an on disk page.
Tx provides access to pages in a File.
TxOptions adds some per transaction options user can set.
TxStats contains common statistics collected during the life-cycle of a transaction.

# Interfaces

Observer defines common callbacks to observe errors, transactions and other state changes in txfile.

# Type aliases

ErrKind defines txfile error kinds(codes).
Flag configures file opening behavior.
PageID used to reference a file pages.
SyncMode selects the file syncing behavior.