Enum ControlError 

pub enum ControlError {
    NoSuchSession(SessionId),
    NoSuchWindow(WindowId),
    NoSuchPane(PaneId),
    Transport(String),
    Rejected(String),
    Unsupported {
        capability: &'static str,
        detail: String,
    },
    Internal(Error),
}

Failure modes a MultiplexerControl op can return. Variants stay narrow so consumers can pattern-match on the recoverable vs not-recoverable ones (e.g. RPC retries on Transport but gives up on NoSuchSession).

Variants

NoSuchSession(SessionId)

NoSuchWindow(WindowId)

NoSuchPane(PaneId)

Transport(String)

Rejected(String)

Unsupported

The backend on the other end of the wire does not implement a named crate::capability::Capability this call needs.

Raised client-side, before the request goes out — the point is to refuse legibly instead of sending a frame the daemon will decode successfully and then silently ignore part of. capability is the wire name ("spawn-args"), so a caller can match on it without string-scraping detail.

Deliberately has no crate::wire::WireError mirror: adding a WireError variant would be a wire change that older clients could not decode, and this error is never produced by a daemon. If one ever needs to, it degrades to Rejected on the wire (see the From impl in wire.rs).

Fields

capability: &'static str

detail: String

Internal(Error)

Trait Implementations

impl Debug for ControlError

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

Formats the value using the given formatter.

impl Display for ControlError

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

Formats the value using the given formatter.

impl Error for ControlError

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<ControlError> for WireError

fn from(e: ControlError) -> Self

Converts to this type from the input type.

impl From<Error> for ControlError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<WireError> for ControlError

fn from(e: WireError) -> Self

Converts to this type from the input type.