Struct NetworkError 

pub struct NetworkError(/* private fields */);

The single error type used across the entire Citadel workspace.

Pointer-sized (8 bytes): the payload is boxed so Result<T, NetworkError> stays lean on the common Ok path. Construct via the [crate::error!] macro. Derefs to [NetworkErrorInner], so err.code works directly.

Implementations

impl NetworkError

pub fn generic(msg: impl ErrorArgs) -> NetworkError

A generic, uncategorized error. Prefer a specific [ErrorCode].

pub fn msg(msg: impl ErrorArgs) -> NetworkError

Alias of NetworkError::generic.

pub fn socket(msg: impl ErrorArgs) -> NetworkError

A low-level socket error.

pub fn timeout(value: u64) -> NetworkError

An operation timed out (value is the elapsed/limit or subject).

pub fn invalid_packet(msg: impl ErrorArgs) -> NetworkError

A received packet failed structural validation.

pub fn invalid_packet_size(size: usize) -> NetworkError

A packet’s size was rejected.

pub fn invalid_request(msg: impl ErrorArgs) -> NetworkError

A request was malformed or not permitted in the current state.

pub fn internal(msg: impl ErrorArgs) -> NetworkError

An internal protocol invariant was violated.

pub fn node_remote_send(reason: impl ErrorArgs) -> NetworkError

Failed to hand a request to the node’s remote.

pub fn proper_shutdown() -> NetworkError

The session shut down cleanly.

pub fn io(msg: impl ErrorArgs) -> NetworkError

A wrapped I/O error described by msg.

pub fn encrypt(msg: impl ErrorArgs) -> NetworkError

Encryption failed (with context).

pub fn decrypt(msg: impl ErrorArgs) -> NetworkError

Decryption failed (with context).

pub fn rekey_update(msg: impl ErrorArgs) -> NetworkError

A rekey/ratchet-update step failed.

pub fn ratchet(msg: impl ErrorArgs) -> NetworkError

A ratchet operation failed.

pub fn out_of_bounds() -> NetworkError

An index/length was outside the valid range.

pub fn bad_security_setting() -> NetworkError

The requested security setting was invalid or unsupported.

pub fn fatal_crypt(msg: impl ErrorArgs) -> NetworkError

An unrecoverable cryptographic fault.

pub fn shared_secret_not_loaded() -> NetworkError

The shared secret has not been loaded yet.

pub fn encryption_failure() -> NetworkError

A generic encryption failure (no further context).

pub fn decryption_failure() -> NetworkError

A generic decryption failure (no further context).

pub fn invalid_length() -> NetworkError

A buffer/key length was invalid.

pub fn unsupported_algorithm() -> NetworkError

The requested algorithm is not supported.

pub fn account_client_exists(cid: u64) -> NetworkError

A client account already exists (cid).

pub fn account_client_non_exists(cid: u64) -> NetworkError

The referenced client account does not exist (cid).

pub fn account_server_exists(cid: u64) -> NetworkError

A server account already exists (cid).

pub fn account_server_non_exists(cid: u64) -> NetworkError

The referenced server account does not exist (cid).

pub fn account_invalid_username() -> NetworkError

The supplied username was invalid.

pub fn account_invalid_password() -> NetworkError

The supplied password was invalid.

pub fn account_disengaged(cid: u64) -> NetworkError

The account is disengaged / deregistered (cid).

pub fn firewall_upnp(msg: impl ErrorArgs) -> NetworkError

A UPnP operation failed.

pub fn firewall_hole_punch(msg: impl ErrorArgs) -> NetworkError

A hole-punch operation failed.

pub fn firewall_skip() -> NetworkError

Firewall traversal was deliberately skipped.

pub fn firewall_not_applicable() -> NetworkError

Firewall traversal was not applicable in this context.

pub fn firewall_hole_punch_exhausted() -> NetworkError

All hole-punch attempts were exhausted.

pub fn firewall_local_ip_fail() -> NetworkError

The local IP address could not be determined.

pub fn channel_send(msg: impl ErrorArgs) -> NetworkError

A channel send failed (receiver gone or full).

pub fn channel_recv() -> NetworkError

A channel receive failed (sender gone).

pub fn channel_internal(msg: impl ErrorArgs) -> NetworkError

An internal channel invariant was violated.

pub fn ip_retrieve(msg: impl ErrorArgs) -> NetworkError

Failed to retrieve the public/external IP address.

pub fn rtdb(msg: impl ErrorArgs) -> NetworkError

A Firebase RTDB operation failed.

impl NetworkError

pub fn from_parts( code: ErrorCode, origin: &'static str, args: Vec<Box<dyn ErrorArgs>>, ) -> NetworkError

Build an error from its parts. Prefer the [crate::error!] macro, which captures origin and validates the argument count at compile time. args[i] fills the i-th {} in the form.

pub fn code(&self) -> ErrorCode

The stable error code.

pub fn code_u16(&self) -> u16

The stable numeric error code (the [ErrorCode] #[repr(u16)] discriminant).

pub fn error_source(&self) -> &'static str

The call-site "file:line" where this error was raised.

pub fn into_string(self) -> String

Consume into the full rendered message.

Trait Implementations

impl Clone for NetworkError

fn clone(&self) -> NetworkError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NetworkError

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

Formats the value using the given formatter.

impl Deref for NetworkError

type Target = NetworkErrorInner

The resulting type after dereferencing.

fn deref(&self) -> &NetworkErrorInner

Dereferences the value.

impl DerefMut for NetworkError

fn deref_mut(&mut self) -> &mut NetworkErrorInner

Mutably dereferences the value.

impl Display for NetworkError

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

Formats the value using the given formatter.

impl Error for NetworkError

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 NetworkError

fn from(err: Error) -> NetworkError

Converts to this type from the input type.

impl<T> From<SendError<T>> for NetworkError

fn from(err: SendError<T>) -> NetworkError

Converts to this type from the input type.

impl Hash for NetworkError

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NetworkError

Errors compare equal iff they carry the same [ErrorCode] (arguments and origin are ignored).

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for NetworkError