Skip to main content

NetworkErrorDisplay

Struct NetworkErrorDisplay 

Source
pub struct NetworkErrorDisplay {
    pub error_code: ErrorCode,
    pub connection: ConnectionDetails,
    pub network_path: Vec<NetworkPathSegment>,
    pub env_vars: Vec<EnvVarInfo>,
    pub diagnostics: Vec<DiagnosticCommand>,
    pub timeout: Option<Duration>,
    pub retry_count: Option<u32>,
    pub raw_error: Option<String>,
    pub caused_by: Vec<String>,
    pub custom_message: Option<String>,
}
Expand description

NetworkErrorDisplay - Rich error display for network/SSH errors.

Builds on ErrorPanel with network-specific context:

  • Connection details (host, port, IP, credentials)
  • Network path visualization
  • Environment variable display
  • Diagnostic command suggestions

Fields§

§error_code: ErrorCode

The underlying error code

§connection: ConnectionDetails

Connection details

§network_path: Vec<NetworkPathSegment>

Network path segments for visualization

§env_vars: Vec<EnvVarInfo>

Relevant environment variables

§diagnostics: Vec<DiagnosticCommand>

Diagnostic command suggestions

§timeout: Option<Duration>

Connection timeout if applicable

§retry_count: Option<u32>

Retry information

§raw_error: Option<String>

Low-level error message from OS/library

§caused_by: Vec<String>

Error chain (caused by)

§custom_message: Option<String>

Custom message override

Implementations§

Source§

impl NetworkErrorDisplay

Source

pub fn ssh_connection_failed(host: impl Into<String>) -> Self

Create display for SSH connection failure (E100).

Source

pub fn ssh_auth_failed(host: impl Into<String>) -> Self

Create display for SSH authentication failure (E101).

Source

pub fn ssh_key_error(host: impl Into<String>) -> Self

Create display for SSH key error (E102).

Source

pub fn ssh_host_key_error(host: impl Into<String>) -> Self

Create display for SSH host key verification failure (E103).

Source

pub fn ssh_timeout(host: impl Into<String>) -> Self

Create display for SSH timeout (E104).

Source

pub fn ssh_session_dropped(host: impl Into<String>) -> Self

Create display for SSH session dropped (E105).

Source

pub fn dns_error(host: impl Into<String>) -> Self

Create display for DNS resolution failure (E106).

Source

pub fn network_unreachable(host: impl Into<String>) -> Self

Create display for network unreachable (E107).

Source

pub fn connection_refused(host: impl Into<String>) -> Self

Create display for connection refused (E108).

Source

pub fn tcp_timeout(host: impl Into<String>) -> Self

Create display for TCP timeout (E109).

Source

pub fn port(self, port: u16) -> Self

Set the port number.

Source

pub fn resolved_ip(self, ip: IpAddr) -> Self

Set the resolved IP address.

Source

pub fn username(self, username: impl Into<String>) -> Self

Set the SSH username.

Source

pub fn key_path(self, path: impl Into<String>) -> Self

Set the SSH key path.

Source

pub fn timeout(self, timeout: Duration) -> Self

Set the timeout duration.

Source

pub fn timeout_secs(self, secs: u64) -> Self

Set the timeout in seconds (convenience method).

Source

pub fn retries(self, count: u32) -> Self

Set the retry count.

Source

pub fn path_segment( self, name: impl Into<String>, status: PathSegmentStatus, details: Option<String>, ) -> Self

Add a network path segment.

Source

pub fn network_path_simple( self, local: &str, daemon: &str, worker: &str, failed_at: Option<&str>, ) -> Self

Set the full network path with simple status.

Creates a path like: local → daemon → worker The failed segment is marked based on which name matches failed_at.

Source

pub fn env_var(self, name: impl Into<String>, value: Option<String>) -> Self

Add an environment variable with its current value.

Source

pub fn env_var_from_env(self, name: &str) -> Self

Add an environment variable, reading from the current environment.

Source

pub fn auto_add_ssh_env_vars(self) -> Self

Automatically add common SSH-related environment variables.

Source

pub fn add_diagnostic( self, description: impl Into<String>, command: impl Into<String>, ) -> Self

Add a diagnostic command suggestion.

Source

pub fn with_io_error(self, err: &Error) -> Self

Extract details from a std::io::Error.

Source

pub fn message(self, message: impl Into<String>) -> Self

Set a custom error message.

Source

pub fn caused_by(self, cause: impl Into<String>) -> Self

Add a caused-by entry.

Source

pub fn to_error_panel(&self) -> ErrorPanel

Convert to an ErrorPanel for rendering.

Source

pub fn render(&self, ctx: OutputContext)

Render the error to stderr.

Uses rich output if supported, otherwise plain text.

Source

pub fn to_json(&self) -> Result<String>

Serialize to JSON string.

Source

pub fn to_json_compact(&self) -> Result<String>

Serialize to compact JSON string.

Trait Implementations§

Source§

impl Clone for NetworkErrorDisplay

Source§

fn clone(&self) -> NetworkErrorDisplay

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NetworkErrorDisplay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for NetworkErrorDisplay

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for NetworkErrorDisplay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for NetworkErrorDisplay

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl Serialize for NetworkErrorDisplay

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<E> IntoErrorPanel for E
where E: Error,

Source§

fn into_panel(self) -> ErrorPanel

Convert this error into an ErrorPanel.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,