Enum Refusal 

pub enum Refusal {
    SessionNotAccepting {
        state: SessionState,
    },
    NotPermitted {
        state: SessionState,
    },
    HandshakeIncomplete {
        state: SessionState,
    },
    Unnegotiated {
        state: SessionState,
    },
}

A message the session would not admit, and why.

Separate from EngineError because nothing failed: the message was understood, the session simply is not in a position to take it, and the peer is owed a JSON-RPC error rather than a dropped connection. Every variant carries the state that produced the refusal, because that is the one fact an operator needs and the one a peer’s bug report will not have.

Variants

SessionNotAccepting

The session is closing or closed, so nothing is admitted at all.

Checked before the lifecycle is consulted, so no protocol has to remember to re-implement the terminal case.

Fields

state: SessionState

Where the session was.

NotPermitted

The protocol said this method is not permitted here.

Fields

state: SessionState

Where the session was.

HandshakeIncomplete

The method is ordinary work and the session has not finished its handshake.

Fields

state: SessionState

Where the session was.

Unnegotiated

Nothing has been negotiated, so there is no profile to gate against.

Distinct from HandshakeIncomplete because the lifecycle may well have permitted the method and had no profile to check it against. Reporting “not permitted” there would blame the peer for a session that has not started.

Fields

state: SessionState

Where the session was.

Implementations

impl Refusal

pub const fn state(&self) -> SessionState

The state that produced the refusal.

Trait Implementations

impl Clone for Refusal

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Refusal

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

Formats the value using the given formatter.

impl Display for Refusal

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

Formats the value using the given formatter.

impl Eq for Refusal

impl Error for Refusal

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 PartialEq for Refusal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Refusal