Enum libqaul::error::Error

pub enum Error {
    NotAuthorised,
    NoUser,
    ContactExists,
    NoContact,
    InvalidQuery,
    NoData,
    InvalidPayload,
    CallbackTimeout,
    NoSign,
    BadSign,
    NetworkFault,
    NoRoute,
    BadSerialise,
    NoService,
    ServiceExists,
    CommFault,
}

libqaul service API error states

All errors that can occur in interaction with the API are encoded as variants on this enum. In most cases, no additional metadata is provided and needs to be inferred from whatever context or function call emitted the error. Check the variant doc comments for a broad overview, as well as detailed usage instructions.

A note on language

Most variants of this enum use either an Invalid or No prefix. Invalid data is data that was either not expected or badly formatted. No in this case takes the place of Unknown, meaning that a query could not be fulfilled.

Variants

NotAuthorised

Not authorised to perform this action

NoUser

The desired user was not known

ContactExists

The provided contact already exists

NoContact

The desired contact does not exist

InvalidQuery

Invalid search query

NoData

No data was returned for the provided query

InvalidPayload

Invalid payload (probably too big)

CallbackTimeout

A function callback timed out

NoSign

Signature with an unknown public key

BadSign

Fraudulent signature for a known public key

NetworkFault

A generic networking error occured

NoRoute

Failed to find a route to this user

BadSerialise

Some serialisation action failed

NoService

No such service was found

ServiceExists

A sevice with this name already exists

CommFault

Some internal components failed to communicate

Implementations

impl Error

pub fn help(&self) -> String

Trait Implementations

impl Clone for Error

pub fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Error, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<Error> for Error

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Error

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Error

impl StructuralPartialEq for Error