Enum CompensationHint 

#[non_exhaustive]
pub enum CompensationHint {
    UniqueViolation {
        field: String,
        conflicting_value: String,
    },
    ForeignKeyMissing {
        referenced_id: String,
    },
    PermissionDenied,
    RateLimited {
        retry_after_ms: u64,
    },
    SchemaViolation {
        field: String,
        reason: String,
    },
    Custom {
        constraint: String,
        detail: String,
    },
    IntegrityViolation,
    Retry {
        retry_after_ms: u64,
    },
}

Typed compensation hint sent from Origin to edge when a delta is rejected.

The edge’s CompensationHandler receives this and can programmatically decide how to react (prompt user, auto-retry with suffix, silently merge).

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.

UniqueViolation

UNIQUE constraint violated — another device wrote the same value first.

Fields

field: String

The field that has the UNIQUE constraint (e.g., “username”).

conflicting_value: String

The conflicting value that was already taken.

ForeignKeyMissing

Foreign key reference missing — the referenced entity doesn’t exist.

Fields

referenced_id: String

The ID that was referenced but not found.

PermissionDenied

Permission denied — the user doesn’t have write access. No details are leaked (security: the edge is untrusted).

RateLimited

Rate limit exceeded — try again later.

Fields

retry_after_ms: u64

Suggested delay before retrying (milliseconds).

SchemaViolation

Schema violation — the delta doesn’t conform to the collection schema.

Fields

field: String

Which field failed validation.

reason: String

Human-readable reason.

Custom

Custom application-defined constraint violation.

Fields

constraint: String

Constraint name.

detail: String

Typed payload for the application to interpret.

IntegrityViolation

Data integrity violation — CRC32C checksum mismatch on delta payload. The client should re-send the delta.

Retry

Transient rejection — the delta was admitted against a constraint version not yet installed on the accepting replica. Not a failure: re-push the delta as a new sequence after the suggested delay.

Fields

retry_after_ms: u64

Suggested delay before re-pushing (milliseconds).

Implementations

impl CompensationHint

pub fn code(&self) -> &'static str

Returns a short, machine-readable code for the hint type.

Trait Implementations

impl Archive for CompensationHint

where String: Archive, u64: Archive,

type Archived = ArchivedCompensationHint

The archived representation of this type.

type Resolver = CompensationHintResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <Self as Archive>::Resolver, out: Place<<Self as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for CompensationHint

fn clone(&self) -> CompensationHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompensationHint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompensationHint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<CompensationHint, __D> for Archived<CompensationHint>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, u64: Archive, <u64 as Archive>::Archived: Deserialize<u64, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<CompensationHint, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for CompensationHint

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

Formats the value using the given formatter.

impl Eq for CompensationHint

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for CompensationHint

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 PartialEq for CompensationHint

fn eq(&self, other: &CompensationHint) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CompensationHint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<__S: Fallible + ?Sized> Serialize<__S> for CompensationHint

where String: Serialize<__S>, u64: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for CompensationHint

impl ToMessagePack for CompensationHint

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

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