Enum SyncError 

pub enum SyncError {
    Transport(String),
    Handshake(String),
    Serialization(String),
    Timeout,
    ConnectionLost,
    ProtocolVersion {
        local: u32,
        remote: u32,
    },
    WireFormatMismatch {
        expected: u8,
        got: Option<u8>,
    },
    InvalidPayload(String),
    CursorNotFound {
        instance: InstanceId,
    },
    Shutdown,
}

Available on crate feature sync only.

Errors specific to the sync protocol.

These are wrapped into crate::PulseDBError::Sync when propagated through the public API.

Variants

Transport(String)

Transport-level failure (network I/O, connection refused, etc.).

Handshake(String)

Handshake was rejected by the remote peer.

Serialization(String)

Failed to serialize or deserialize a sync message.

Timeout

Operation timed out waiting for a response.

ConnectionLost

Connection to the remote peer was lost.

ProtocolVersion

Protocol version mismatch between peers.

Fields

local: u32

Local protocol version.

remote: u32

Remote protocol version.

WireFormatMismatch

Wire-format preamble mismatch — caught by raw-byte inspection of the 3-byte preamble before any deserialize, so a serializer mismatch (e.g. a bincode-era peer vs a postcard-era peer) fails loud with a typed error instead of yielding garbage through the decoder.

This is distinct from SyncError::ProtocolVersion: that variant is protocol-semantics (negotiated in-band after a successful decode); this variant is wire-format (the bytes can’t be trusted to decode at all). Two failure shapes feed it:

• bad magic (got == None): the leading bytes are not a PulseDB sync preamble at all (truncated body, a non-PulseDB POST, or a pre-4.0 no-preamble peer’s body) — reported with got: None.
• wrong version (got == Some(v)): a valid magic but a wire_format_version byte this peer does not speak.

Fields

expected: u8

The wire-format version this peer speaks.

got: Option<u8>

The wire-format version observed in the preamble, or None when the magic bytes were absent/wrong (so no trustworthy version was read).

InvalidPayload(String)

Received an invalid or unrecognized payload.

CursorNotFound

No cursor found for the specified peer instance.

Fields

instance: InstanceId

The peer instance whose cursor was not found.

Shutdown

The sync system is shutting down.

Implementations

impl SyncError

pub fn transport(msg: impl Into<String>) -> Self

Creates a transport error with the given message.

pub fn handshake(msg: impl Into<String>) -> Self

Creates a handshake error with the given message.

pub fn serialization(msg: impl Into<String>) -> Self

Creates a serialization error with the given message.

pub fn invalid_payload(msg: impl Into<String>) -> Self

Creates an invalid payload error with the given message.

pub fn wire_format_bad_magic(expected: u8) -> Self

Creates a wire-format mismatch for a bad / absent magic preamble.

Used when the leading bytes are not a recognizable PulseDB sync preamble (truncated body, wrong magic, or a pre-preamble peer’s body).

pub fn wire_format_version(expected: u8, got: u8) -> Self

Creates a wire-format mismatch for a wrong wire-format version.

Used when the magic is valid but the wire_format_version byte names a version this peer does not speak.

pub fn is_transport(&self) -> bool

Returns true if this is a transport error.

pub fn is_timeout(&self) -> bool

Returns true if this is a timeout error.

pub fn is_connection_lost(&self) -> bool

Returns true if this is a connection lost error.

pub fn is_shutdown(&self) -> bool

Returns true if this is a shutdown error.

pub fn is_wire_format_mismatch(&self) -> bool

Returns true if this is a wire-format mismatch (bad magic OR wrong wire-format version) — the typed fail-loud signal for cross-version sync, distinct from a generic SyncError::Serialization.

Trait Implementations

impl Debug for SyncError

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

Formats the value using the given formatter.

impl Display for SyncError

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

Formats the value using the given formatter.

impl Error for SyncError

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 SyncError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<SyncError> for PulseDBError

fn from(source: SyncError) -> Self

Converts to this type from the input type.