Enum VeilidAPIError 

pub enum VeilidAPIError {
    NotInitialized,
    AlreadyInitialized,
    Timeout,
    TryAgain {
        message: String,
    },
    InvalidTarget {
        message: String,
    },
    NoConnection {
        message: String,
    },
    Shutdown,
    KeyNotFound {
        key: OpaqueRecordKey,
    },
    Internal {
        message: String,
    },
    Unimplemented {
        message: String,
    },
    ParseError {
        message: String,
        value: String,
    },
    InvalidArgument {
        context: String,
        argument: String,
        value: String,
    },
    MissingArgument {
        context: String,
        argument: String,
    },
    Generic {
        message: String,
    },
    TransactionNotFound {
        message: String,
    },
}

Error type returned by all fallible Veilid API operations.

Variants

NotInitialized

The API was used before VeilidAPI was attached, or after it was detached.

AlreadyInitialized

An attempt was made to initialize Veilid while it was already running.

Timeout

The operation did not complete within its time budget.

TryAgain

The operation could not be completed yet and should be retried later.

Fields

message: String

Why the operation could not complete this time.

InvalidTarget

The destination for an operation could not be reached or is malformed.

Fields

message: String

Details about the unreachable or malformed target.

NoConnection

No network connection could be established to carry out the operation.

Fields

message: String

Details about the connection failure.

Shutdown

The API is shutting down and can no longer service requests.

KeyNotFound

The requested DHT record key is not present in local storage.

Fields

key: OpaqueRecordKey

The record key that was not found.

Internal

An internal invariant was violated; indicates a bug in Veilid itself.

Fields

message: String

Details about the internal failure.

Unimplemented

The requested feature exists in the API surface but is not yet implemented on this platform or build.

Fields

message: String

Which functionality is unimplemented.

ParseError

A value could not be parsed into its expected form.

Fields

message: String

What went wrong while parsing.

value: String

The input value that failed to parse.

InvalidArgument

An argument was supplied but its value was rejected.

Fields

context: String

The calling context that rejected the argument.

argument: String

The name of the offending argument.

value: String

The rejected value.

MissingArgument

A required argument was not supplied.

Fields

context: String

The calling context that required the argument.

argument: String

The name of the missing argument.

Generic

A failure that does not fit any more specific category.

Fields

message: String

Details about the failure.

TransactionNotFound

The referenced DHT transaction does not exist, having expired or never been opened.

Fields

message: String

Details about the missing transaction.

Implementations

impl VeilidAPIError

pub fn not_initialized() -> Self

Construct a VeilidAPIError::NotInitialized error.

pub fn already_initialized() -> Self

Construct a VeilidAPIError::AlreadyInitialized error.

pub fn timeout() -> Self

Construct a VeilidAPIError::Timeout error.

pub fn try_again<T: ToVeilidAPIErrorArgument>(msg: T) -> Self

Construct a VeilidAPIError::TryAgain error with the given message.

pub fn shutdown() -> Self

Construct a VeilidAPIError::Shutdown error.

pub fn invalid_target<T: ToVeilidAPIErrorArgument>(msg: T) -> Self

Construct a VeilidAPIError::InvalidTarget error with the given message.

pub fn no_connection<T: ToVeilidAPIErrorArgument>(msg: T) -> Self

Construct a VeilidAPIError::NoConnection error with the given message.

pub fn key_not_found(key: OpaqueRecordKey) -> Self

Construct a VeilidAPIError::KeyNotFound error for the given record key.

pub fn parse_error<T: ToVeilidAPIErrorArgument, S: ToVeilidAPIErrorArgument>( msg: T, value: S, ) -> Self

Construct a VeilidAPIError::ParseError error with the given message and offending value.

pub fn invalid_argument<T: ToVeilidAPIErrorArgument, S: ToVeilidAPIErrorArgument, R: ToVeilidAPIErrorArgument>( context: T, argument: S, value: R, ) -> Self

Construct a VeilidAPIError::InvalidArgument error naming the context, argument, and rejected value.

pub fn missing_argument<T: ToVeilidAPIErrorArgument, S: ToVeilidAPIErrorArgument>( context: T, argument: S, ) -> Self

Construct a VeilidAPIError::MissingArgument error naming the context and the missing argument.

pub fn generic<T: ToVeilidAPIErrorArgument>(msg: T) -> Self

Construct a VeilidAPIError::Generic error with the given message.

pub fn from_network_result<T>(nr: NetworkResult<T>) -> Result<T, Self>

Convert a NetworkResult into a VeilidAPIResult, mapping each non-value outcome to the matching error variant.

pub fn log_level(&self) -> Level

The tracing log level at which this error should be reported.

pub fn internal<T: ToString>(msg: T) -> Self

Construct a VeilidAPIError::Internal error with the given message. Constructing one signals a bug in Veilid.

pub fn unimplemented<T: ToString>(msg: T) -> Self

Construct a VeilidAPIError::Unimplemented error with the given message.

Trait Implementations

impl Clone for VeilidAPIError

fn clone(&self) -> VeilidAPIError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VeilidAPIError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VeilidAPIError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VeilidAPIError

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

Formats the value using the given formatter.

impl Eq for VeilidAPIError

impl Error for VeilidAPIError

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 VeilidAPIError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl Ord for VeilidAPIError

fn cmp(&self, other: &VeilidAPIError) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VeilidAPIError

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VeilidAPIError

fn partial_cmp(&self, other: &VeilidAPIError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VeilidAPIError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VeilidAPIError