Enum LogError 

pub enum LogError {
    Io(Error),
    PartialBatch {
        segment: Offset,
        file_offset: u64,
    },
    CrcMismatch {
        segment: Offset,
        file_offset: u64,
        expected: u32,
        computed: u32,
    },
    OffsetTooLow {
        requested: Offset,
        log_start: Offset,
    },
    OffsetBelowLocalStart {
        requested: Offset,
        local_log_start: Offset,
    },
    Records(RecordsError),
    BadSegmentName(String),
    OffsetMismatch {
        expected: Offset,
        actual: Offset,
    },
    Corrupt(String),
    UnsupportedFormatVersion {
        artifact: &'static str,
        path: PathBuf,
        found: i64,
    },
    MissingFormatVersion {
        artifact: &'static str,
        path: PathBuf,
    },
    InvalidControlRecordSize {
        record: &'static str,
        needed: usize,
        found: usize,
    },
    InvalidControlRecordVersion {
        record: &'static str,
        version: i16,
    },
    InvalidArgument(String),
    RecordTooLarge {
        size: usize,
        limit: usize,
    },
    ScheduleRunsBackwards {
        delivery_ms: i64,
    },
    Fenced,
}

Errors returned by Log and Segment.

Variants

Io(Error)

An I/O operation against the filesystem failed.

PartialBatch

Recovery found a partial batch at the tail of a .log file. The log truncates the trailing bytes back to the last cleanly decoded batch.

Fields

segment: Offset

Absolute base offset of the segment containing the partial batch.

file_offset: u64

Byte position within the .log file where the partial batch starts.

CrcMismatch

A batch’s stored CRC did not match the one computed over its bytes.

Fields

segment: Offset

Absolute base offset of the segment.

file_offset: u64

Byte position within the .log file where the corrupt batch starts.

expected: u32

CRC value embedded in the batch header.

computed: u32

CRC value re-computed by the reader.

OffsetTooLow

A caller requested an offset below Log::log_start_offset.

Fields

requested: Offset

Offset the caller asked for.

log_start: Offset

Current log start.

OffsetBelowLocalStart

A caller requested an offset that is at or above Log::log_start_offset but below Log::local_log_start_offset.

KIP-405: the records are in the remote tier and no local segment holds them. The broker’s fetch path answers OFFSET_OUT_OF_RANGE and then falls through to the remote reader, which is where these offsets are served from.

Fields

requested: Offset

Offset the caller asked for.

local_log_start: Offset

First offset the local segments still hold.

Records(RecordsError)

The encode or decode of a RecordBatch failed.

BadSegmentName(String)

A segment filename would not parse. For example, it has the wrong length, or it is not all digits.

OffsetMismatch

A caller supplied an explicit offset to Log::append_at that was below the log’s current end offset. Replication paths use this to detect a duplicate or a divergence between leader-assigned offsets and the local log’s expected next offset.

Fields

expected: Offset

The lowest offset the log takes, that is, its current end offset.

actual: Offset

The offset the caller actually supplied.

Corrupt(String)

A log file such as .txnindex is corrupt. It has the wrong size, a bad checksum, or a similar defect.

UnsupportedFormatVersion

A persisted sidecar or checkpoint names a format version this build does not read. A future 1.x broker wrote it, or it is not the artifact its name says.

Fields

artifact: &'static str

The artifact kind, such as stampindex or leader-epoch-checkpoint.

path: PathBuf

The file that carries the version.

found: i64

The version the file carries.

MissingFormatVersion

A persisted sidecar or checkpoint has no version marker. Only a broker before 1.0 wrote that layout, and 1.x reads no 0.x data.

Fields

artifact: &'static str

The artifact kind, such as stampindex or leader-epoch-checkpoint.

path: PathBuf

The file that lacks the marker.

InvalidControlRecordSize

A control record’s key or end-transaction-marker value is too short to hold its fields. Kafka’s ControlRecordType.parseTypeId throws InvalidRecordException for a short key, and EndTransactionMarker.deserializeValue cannot read a short value.

Fields

record: &'static str

end control record key or end transaction marker value.

needed: usize

The bytes the record must hold.

found: usize

The bytes it holds; a missing key or value counts as zero.

InvalidControlRecordVersion

A control record names a negative key version or end-transaction-marker value version. Kafka’s ControlRecordType.parseTypeId and EndTransactionMarker.deserializeValue throw InvalidRecordException for one: the bytes are corrupt. A version above the current one is not this error; Kafka parses it as the current version.

Fields

record: &'static str

control record for the key, end transaction marker for the value.

version: i16

The negative version the record carries.

InvalidArgument(String)

A caller supplied an invalid argument.

RecordTooLarge

Kafka trunk’s max.decompressed.message.bytes: a compressed batch that a lookup or a compaction pass had to decompress holds a record whose body is larger than LogConfig::max_decompressed_record.

Kafka throws InvalidRecordException from DefaultRecord.readFrom, and the message is its own. The broker answers INVALID_RECORD (87) to a ListOffsets, and the cleaner leaves the partition uncleanable until a pass succeeds.

Fields

size: usize

The record’s body size in bytes, Kafka’s sizeOfBodyInBytes.

limit: usize

The configured maximum.

ScheduleRunsBackwards

KFC-1 delivery.schedule.monotonic: the appended batch’s delivery time precedes a delivery time the partition already holds, so the batch would make the partition’s schedule run backwards.

The log raises it because the log is what serializes appends: the test and the write it guards are one critical section here and nowhere above. The broker answers it with INVALID_TIMESTAMP (32).

Fields

delivery_ms: i64

The refused batch’s delivery time, which is its max_timestamp.

Fenced

The log was fenced with Log::fence because its partition is being removed, and takes no more appends.

Trait Implementations

impl Debug for LogError

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

Formats the value using the given formatter.

impl Display for LogError

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

Formats the value using the given formatter.

impl Error for LogError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for LogError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RecordsError> for LogError

fn from(source: RecordsError) -> Self

Converts to this type from the input type.