Enum SyncError 

#[non_exhaustive]
pub enum SyncError {
    NoTransportEnabled,
    SyncNotEnabled,
    ServerAlreadyRunning {
        address: String,
    },
    ServerNotRunning,
    UnexpectedResponse {
        expected: &'static str,
        actual: String,
    },
    Network(String),
    CommandSendError(String),
    TransportInit(String),
    RuntimeCreation(String),
    ServerBind {
        address: String,
        reason: String,
    },
    ConnectionFailed {
        address: String,
        reason: String,
    },
    Timeout {
        address: String,
        phase: TimeoutPhase,
        elapsed: Duration,
    },
    DeviceKeyNotFound {
        key_name: String,
    },
    UnsupportedTransport {
        transport_type: String,
    },
    InvalidAddress(String),
    PeerNotFound(String),
    PeerAlreadyExists(String),
    SerializationError(String),
    ProtocolMismatch {
        expected: u32,
        received: u32,
    },
    HandshakeFailed(String),
    EntryNotFound(ID),
    InvalidEntry(String),
    SyncProtocolError(String),
    BackendError(String),
    RequestNotFound(String),
    RequestAlreadyExists(String),
    InvalidRequestState {
        request_id: String,
        current_status: String,
        expected_status: String,
    },
    InvalidData(String),
    InsufficientPermission {
        request_id: String,
        required_permission: String,
        actual_permission: Permission,
    },
    AuthenticationRequired(String),
    AuthenticationFailed(String),
    PermissionDenied(String),
    InvalidPublicKey {
        reason: String,
    },
    InvalidKeyName {
        reason: String,
    },
    InstanceDropped,
    BootstrapPending {
        request_id: String,
        message: String,
    },
    BootstrapRejected {
        request_id: String,
        message: String,
    },
    TransportTypeMismatch {
        name: String,
        expected: String,
        found: String,
    },
    TransportNotFound {
        name: String,
    },
    NoTransportForAddress {
        address: Address,
    },
    MultipleTransportErrors {
        errors: Vec<String>,
    },
}

Errors that can occur during synchronization operations.

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.

NoTransportEnabled

No transport has been enabled for network operations.

SyncNotEnabled

Sync has not been enabled on the Instance.

ServerAlreadyRunning

Attempted to start a server when one is already running.

Fields

address: String

ServerNotRunning

Attempted to stop a server when none is running.

UnexpectedResponse

Unexpected response type received from peer.

Fields

expected: &'static str

actual: String

Network(String)

Network communication error.

CommandSendError(String)

Command channel send error.

TransportInit(String)

Transport initialization error.

RuntimeCreation(String)

Runtime creation error for async operations.

ServerBind

Server bind error.

Fields

address: String

reason: String

ConnectionFailed

Client connection error.

Fields

address: String

reason: String

Timeout

A peer did not answer within the transport’s deadline.

Kept apart from SyncError::ConnectionFailed and SyncError::Network because a caller reacts differently to silence than to a refusal: a peer that never answered is worth asking again, while one that answered with an error usually is not. phase carries what the peer proved about itself before the deadline.

Fields

address: String

phase: TimeoutPhase

elapsed: Duration

DeviceKeyNotFound

Device key not found in backend storage.

Fields

key_name: String

UnsupportedTransport

Transport type not supported by this transport implementation.

Fields

transport_type: String

InvalidAddress(String)

Invalid address format.

PeerNotFound(String)

Peer not found.

PeerAlreadyExists(String)

Peer already exists.

SerializationError(String)

Serialization error.

ProtocolMismatch

Protocol version mismatch.

Fields

expected: u32

received: u32

HandshakeFailed(String)

Handshake failed.

EntryNotFound(ID)

Entry not found in backend storage.

InvalidEntry(String)

Invalid entry received (validation failed).

SyncProtocolError(String)

Sync protocol error.

BackendError(String)

Backend storage error.

RequestNotFound(String)

Bootstrap request not found.

RequestAlreadyExists(String)

Bootstrap request already exists.

InvalidRequestState

Invalid bootstrap request state.

Fields

request_id: String

current_status: String

expected_status: String

InvalidData(String)

Invalid data format in stored bootstrap request.

InsufficientPermission

Insufficient permission for the requested operation.

Fields

request_id: String

required_permission: String

actual_permission: Permission

AuthenticationRequired(String)

A request that would be served data carried no proof of key possession.

AuthenticationFailed(String)

The proof of key possession did not hold up.

PermissionDenied(String)

The caller proved its key, but that key has no read access.

InvalidPublicKey

Invalid public key provided.

Fields

reason: String

InvalidKeyName

Invalid key name provided.

Fields

reason: String

InstanceDropped

Instance has been dropped and is no longer available.

BootstrapPending

Bootstrap request is pending manual approval.

Fields

request_id: String

message: String

BootstrapRejected

Bootstrap request was rejected by an administrator.

Fields

request_id: String

message: String

TransportTypeMismatch

Transport configuration type mismatch.

Fields

name: String

expected: String

found: String

TransportNotFound

Transport not found by name.

Fields

name: String

NoTransportForAddress

No transport can handle the given address.

Fields

address: Address

MultipleTransportErrors

Multiple transport operations failed.

Fields

errors: Vec<String>

Implementations

impl SyncError

pub fn is_configuration_error(&self) -> bool

Check if this is a configuration error: the sync stack isn’t ready (sync not attached or no transport registered).

pub fn is_server_error(&self) -> bool

Check if this is a server lifecycle error.

pub fn is_network_error(&self) -> bool

Check if this is a network/connection error.

Includes timeouts: a deadline that expires is one way a network call fails, and callers classifying by this predicate should not have to learn about a new variant to keep treating it as one.

pub fn timeout_phase(&self) -> Option<TimeoutPhase>

Check if this is a timeout, and if so in which phase.

Some(TimeoutPhase::Request) means the peer was reachable and stopped answering; Some(TimeoutPhase::Connect) means it never answered at all.

pub fn is_timeout(&self) -> bool

Check if this is a timeout rather than a refusal or a protocol failure.

pub fn is_protocol_error(&self) -> bool

Check if this is a protocol error (unexpected response).

pub fn is_not_found(&self) -> bool

Check if this is a not found error.

pub fn is_validation_error(&self) -> bool

Check if this is a validation error.

pub fn is_backend_error(&self) -> bool

Check if this is a backend error.

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<SyncError> for Error

fn from(err: SyncError) -> Self

Converts to this type from the input type.