Documents/com.nomemmurrakh.documents/DocumentDecodingException

DocumentDecodingException

class DocumentDecodingException : RuntimeException(source)

Thrown when a document cannot be decoded from storage.

A document is stored as one key per field, so a read can fail on a single field while the rest are intact. This exception names the documentKey and, when one field is implicated, the field, and attaches the underlying cause. It is raised instead of a bare SerializationException so that callers never have to depend on the serialization layer's error types.

Properties

cause

expect open val cause: Throwable?

documentKey

val documentKey: String

the key of the document whose decode failed.

field

val field: String?

the field whose stored value could not be decoded, or null when no single field is implicated.

message

expect open val message: String?