Enum Error

#[non_exhaustive]
pub enum Error {
    VersionIsMissing,
    BadResponse(String),
    RequestGeneratorHasNotBeenInitialized(String),
    InvalidRange {
        start: u32,
        end: u32,
    },
    UnauthenticatedUser,
    InternalChannelIsBroken,
    InvalidSlidingSyncIdentifier,
    JoinError {
        task_description: String,
        error: JoinError,
    },
    NoOlmMachine,
    CryptoStoreError(CryptoStoreError),
}

Internal representation of errors in Sliding Sync.

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.

VersionIsMissing

Sliding sync has been configured with a missing version. See crate::sliding_sync::Version.

BadResponse(String)

The response we’ve received from the server can’t be parsed or doesn’t match up with the current expectations on the client side. A sync-restart might be required.

RequestGeneratorHasNotBeenInitialized(String)

A SlidingSyncListRequestGenerator has been used without having been initialized. It happens when a response is handled before a request has been sent. It usually happens when testing.

InvalidRange

Ranges have a start bound greater than end.

Fields

start: u32

Start bound.

end: u32

End bound.

UnauthenticatedUser

We tried to read the user id of a client but it was missing.

InternalChannelIsBroken

The internal channel of SlidingSync seems to be broken.

InvalidSlidingSyncIdentifier

The name of the Sliding Sync instance is too long.

JoinError

A task failed to execute to completion.

Fields

task_description: String

Task description.

error: JoinError

The original JoinError.

NoOlmMachine

No Olm machine.

CryptoStoreError(CryptoStoreError)

An error occurred during a E2EE operation.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

fn from(source: CryptoStoreError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.