Enum RestoreError 

#[non_exhaustive]
pub enum RestoreError {
    InvalidArgument(String),
    LogDirNotEmpty(PathBuf),
    EmptyArchive {
        prefix: String,
    },
    ChecksumMismatch {
        key: String,
        position: u64,
        expected: u32,
        computed: u32,
    },
    TruncatedSegment {
        key: String,
        position: u64,
        declared: u64,
        available: u64,
    },
    TornCopy {
        topic: String,
        partition: i32,
        segment_id: Uuid,
        artifact: String,
    },
    Authenticity {
        reason: String,
    },
    Integrity(String),
    MetadataDisagreement {
        topic: String,
        partition: i32,
        scanned: String,
        snapshot: String,
    },
    MetadataSnapshot {
        path: PathBuf,
        reason: String,
    },
    MetadataSnapshotTopicMismatch {
        topic: String,
        archive_topic_id: Uuid,
        snapshot_topic_id: String,
    },
    UnknownPartition {
        topic: String,
        partition: i32,
    },
    Format {
        code: i32,
    },
    RemoteStorage(RemoteStorageError),
    ObjectStore(ObjectStoreError),
    Log(LogError),
    Records(RecordsError),
    Io(Error),
}

Every way a point-in-time restore stops.

The variants keep the object key, the byte position, and the partition that identify the failure, because an operator who runs a restore during an incident has to decide whether to re-run with --continue-on-corrupt or to go back to the archive. A message alone does not support that decision.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidArgument(String)

A flag combination the parser accepts but the restore cannot act on.

LogDirNotEmpty(PathBuf)

--log-dir names a directory that already holds entries. A restore writes a complete cluster, so it never merges into existing state.

EmptyArchive

The scan reached the archive but found no segment for any selected topic. A wrong --archive-prefix reads exactly like an empty bucket, so the message carries the prefix that was searched.

Fields

prefix: String

The key prefix the scan searched, empty when the whole bucket was scanned.

ChecksumMismatch

A batch header’s CRC does not match the bytes that follow it.

Fields

key: String

The object key of the artifact that holds the corrupt batch.

position: u64

Byte position of the batch header within that object.

expected: u32

The CRC the batch header declares.

computed: u32

The CRC re-computed over the batch body.

TruncatedSegment

A segment ends part way through a batch. The archived copy is short of the length its last batch header declares.

Fields

key: String

The object key of the short artifact.

position: u64

Byte position of the batch header that overruns the object.

declared: u64

The batch length that header declares.

available: u64

The bytes that remain in the object from position.

TornCopy

A segment copy stopped part way: the archive holds some of the segment’s artifacts and not the rest.

Fields

topic: String

Topic of the incomplete segment.

partition: i32

Partition index of the incomplete segment.

segment_id: Uuid

The segment id the archive names the copy with.

artifact: String

The artifact that is absent, such as .timeindex.

Authenticity

Trusted WORM evidence did not authenticate an archive object or chain.

Fields

reason: String

The failed trust check.

Integrity(String)

Captured diskless-WAL state or a required object is inconsistent.

MetadataDisagreement

The bucket scan and the --rlmm-snapshot do not agree about a partition. One of the two is stale, and a restore must not pick for the operator.

Fields

topic: String

Topic the two sources disagree about.

partition: i32

Partition index the two sources disagree about.

scanned: String

What the bucket scan found.

snapshot: String

What the RLMM snapshot states.

MetadataSnapshot

A controller metadata snapshot could not be decoded.

Fields

path: PathBuf

Snapshot path supplied by --metadata-snapshot.

reason: String

Decoder failure.

MetadataSnapshotTopicMismatch

A topic configuration belongs to a different incarnation of an archived topic, or cannot be tied to one at all.

Fields

topic: String

Topic name shared by the archive and snapshot.

archive_topic_id: Uuid

Topic id carried by the archived partition paths.

snapshot_topic_id: String

Topic id in the snapshot, or absent when its topic record is missing.

UnknownPartition

A bound names a topic partition the archive does not hold. Left unreported this silently restores the partition whole, which is the opposite of what the operator asked for.

Fields

topic: String

Topic the bound names.

partition: i32

Partition index the bound names.

Format

The formatter refused to format the target log directory.

Fields

code: i32

The exit code the formatter returned.

RemoteStorage(RemoteStorageError)

The tiered-storage layer failed.

ObjectStore(ObjectStoreError)

The object store failed, or its configuration was rejected.

Log(LogError)

The target log failed to accept a rehydrated segment.

Records(RecordsError)

A record batch would not decode or re-encode.

Io(Error)

A local filesystem operation failed.

Implementations

impl RestoreError

pub fn exit_code(&self) -> i32

The process exit code this error reports.

The grouping is what an operator acts on: an integrity failure means the archive is damaged and a re-run needs --continue-on-corrupt, while a materialization failure means the target is at fault and the archive is intact.

Trait Implementations

impl Debug for RestoreError

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

Formats the value using the given formatter.

impl Display for RestoreError

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

Formats the value using the given formatter.

impl Error for RestoreError

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 RestoreError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<LogError> for RestoreError

fn from(source: LogError) -> Self

Converts to this type from the input type.

impl From<ObjectStoreError> for RestoreError

fn from(source: ObjectStoreError) -> Self

Converts to this type from the input type.

impl From<RecordsError> for RestoreError

fn from(source: RecordsError) -> Self

Converts to this type from the input type.

impl From<RemoteStorageError> for RestoreError

fn from(source: RemoteStorageError) -> Self

Converts to this type from the input type.