Struct TxnIndex 

pub struct TxnIndex { /* private fields */ }

Implementations

impl TxnIndex

pub fn open(path: PathBuf) -> Result<Self, LogError>

Open or recover a .txnindex file at the given path. This method reads the entire file into memory at startup. An empty file or a missing file is acceptable and means zero aborted transactions.

Errors

Returns an error when log I/O fails, a record or index is corrupt, or the requested offset violates the segment state.

pub fn append(&mut self, entry: AbortedTxn) -> Result<(), LogError>

Append one aborted-txn entry.

Errors

Returns an error when log I/O fails, a record or index is corrupt, or the requested offset violates the segment state.

pub fn truncate_from(&mut self, offset: Offset) -> Result<(), LogError>

Remove entries whose inclusive end reaches the truncated suffix and rewrite the sidecar before it is reused as the active transaction index.

Errors

Returns an I/O error if the transaction-index sidecar cannot be rewritten or synchronized.

pub fn entries(&self) -> &[AbortedTxn]

pub fn on_disk(&self) -> bool

Whether the index has a file on disk.

pub fn collect_aborted( &self, start: Offset, end: Offset, out: &mut Vec<AbortedTxn>, ) -> bool

Kafka’s TransactionIndex.collectAbortedTxns: push every aborted transaction whose offset range overlaps [start, end) onto out, in index order, and return whether the search is complete.

An entry’s last_stable_offset is the first offset of any transaction still open when it aborted. Once that reaches end, every transaction that overlaps the range had completed by then, and its entry is no later than this one, so the search stops here and skips the rest of this index and every later segment’s.

pub fn aborted_in_range( &self, start: Offset, end: Offset, ) -> impl Iterator<Item = &AbortedTxn>

Aborted transactions whose offset range overlaps [start, end).

Trait Implementations

impl Debug for TxnIndex

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.