Struct ErrorPayload 

pub struct ErrorPayload {
    pub code: String,
    pub message: String,
    pub ndb_code: u16,
    pub details: Option<ErrorDetails>,
    pub cause: Option<ErrorCausePayload>,
}

Error details in a response.

Encoded as a MessagePack map rather than an array so that fields can be added without invalidating the frames older peers already understand — the same reason NativeResponse is a map. An array representation has no field names, so a decoder cannot tell a missing optional field from a truncated frame and every addition is a breaking change.

Fields

code: String

SQLSTATE-style error code (e.g., “42P01” for undefined table).

message: String

Human-readable error message.

ndb_code: u16

Stable numeric NodeDB error code (nodedb_types::ErrorCode’s inner value, e.g. 1000 for a constraint violation).

SQLSTATE is many-to-one — a unique violation and a duplicate idempotency key both render as 23505, and everything unclassified renders as XX000 — so it cannot carry the classification a client needs to reconstruct a typed error. This field is the authoritative one for that. 0 means the sending server predates this field, and a client must fall back to a generic error rather than guess. #[serde(default)] + #[msgpack(default)] keep it additive and backward-compatible with peers that never send it.

details: Option<ErrorDetails>

The structured details the server held: the collection, gate, or document the error names. None when the server had none to send.

cause: Option<ErrorCausePayload>

The typed error that caused this one, when the server held one: the Data-Plane refusal behind a phase failure, say. None when there is no cause to report.

Trait Implementations

impl Clone for ErrorPayload

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for ErrorPayload

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl Serialize for ErrorPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessagePack for ErrorPayload

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

fn size_hint(&self) -> Option<TrustedSizeHint>

Returns a trusted upper bound for the number of bytes written by the next call to Self::write, or None when it cannot be determined cheaply.

fn max_size() -> Option<TrustedSizeHint>

Returns a trusted upper bound valid for every value of this type.

fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>

where W: Write, Self: Sized,

Writes the MessagePack representation of a slice of values into the provided writer.