Enum DhtError 

pub enum DhtError {
    Transport(SafeText),
    MalformedResponse(SafeText),
    InvalidHex(SafeText),
    NoPeers,
    Timeout,
}

An error from a DHT operation.

Variants

Transport(SafeText)

A transport-level failure talking to a peer (connect failed, stream error, timeout). Carries the underlying reason as text — the DHT treats a transport failure to one peer as that peer being unreachable and continues the lookup with others.

MalformedResponse(SafeText)

A peer’s response could not be parsed / did not match the expected shape for the request.

The reason describes the failure WITHOUT quoting the response, because the response is exactly the thing the peer chose — see SafeText::describing_json_error.

InvalidHex(SafeText)

A hex peer_id / content key / root supplied to the API was not valid 64-char hex.

NoPeers

The lookup could not proceed because the routing table + bootstrap set were empty — there is no one to ask. Bootstrap the node with at least one reachable peer first.

Timeout

The RPC timed out waiting for a peer response.

Implementations

impl DhtError

pub fn transport(text: impl Into<SafeText>) -> Self

Build a DhtError::Transport from text THIS CRATE wrote.

Accepts a &'static str (a source literal) or an already-vetted SafeText. It deliberately does NOT accept a String or an arbitrary Display: those are how a peer’s own bytes used to get in. For a message derived from a remote party, say so with Self::transport_from_untrusted.

use dig_dht::DhtError;

let err = DhtError::transport("connection refused");
assert_eq!(err.to_string(), "transport error: connection refused");

A raw String — the shape that let peer text in — no longer compiles:

use dig_dht::DhtError;

let from_the_wire: String = std::env::var("PEER_SAID").unwrap_or_default();
let err = DhtError::transport(from_the_wire);

pub fn transport_from_untrusted(reason: impl Display) -> Self

Build a DhtError::Transport from text of REMOTE origin, neutralizing it on the way in.

Use this for an io::Error, a TLS error, or any message whose content a peer could have influenced. The name is the documentation: a reader of the call site can see that untrusted text is entering an error, which is precisely what a bare String parameter concealed.

pub fn malformed_response(error: &Error) -> Self

Build a DhtError::MalformedResponse describing a serde_json decode failure on a peer’s reply, without quoting the reply.

pub fn invalid_hex(which: &'static str) -> Self

Build a DhtError::InvalidHex naming WHICH argument was not canonical 64-hex.

The offending value is NOT echoed. A non-canonical identifier is by definition not one of our own, so quoting it back would put a stranger’s bytes in the message; the caller already knows what it passed, so naming the argument is the diagnosis that actually helps.

Trait Implementations

impl Debug for DhtError

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

Formats the value using the given formatter.

impl Display for DhtError

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

Formats the value using the given formatter.

impl Error for DhtError

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.