Struct ConfigErrorDisplay 

pub struct ConfigErrorDisplay {

    pub error_code: ErrorCode,
    pub location: Option<ConfigLocation>,
    pub snippet: Option<ConfigSnippet>,
    pub type_mismatch: Option<TypeMismatch>,
    pub search_paths: Option<ConfigSearchPaths>,
    pub env_var_name: Option<String>,
    pub env_var_value: Option<String>,
    pub profile_name: Option<String>,
    pub worker_id: Option<String>,
    pub ssh_key_path: Option<PathBuf>,
    pub socket_path: Option<PathBuf>,
    pub permission_mode: Option<String>,
    pub required_mode: Option<String>,
    pub raw_error: Option<String>,
    pub caused_by: Vec<String>,
    pub custom_message: Option<String>,
}

ConfigErrorDisplay - Rich error display for configuration errors.

Builds on ErrorPanel with config-specific context:

• File location (path, line, column)
• Content snippets with highlighting
• Expected vs actual values
• Config search paths
• Environment variable issues

Fields

error_code: ErrorCode

The underlying error code.

location: Option<ConfigLocation>

Location in the config file.

snippet: Option<ConfigSnippet>

Code snippet showing the error.

type_mismatch: Option<TypeMismatch>

Type mismatch details.

search_paths: Option<ConfigSearchPaths>

Search paths for “not found” errors.

env_var_name: Option<String>

Environment variable name (for env errors).

env_var_value: Option<String>

Environment variable value (for env errors).

profile_name: Option<String>

Profile name (for profile not found).

worker_id: Option<String>

Worker ID (for worker config errors).

ssh_key_path: Option<PathBuf>

SSH key path (for key errors).

socket_path: Option<PathBuf>

Socket path (for socket errors).

permission_mode: Option<String>

Permission mode (for permission errors).

required_mode: Option<String>

Required permission mode.

raw_error: Option<String>

Raw error message from TOML parser or IO.

caused_by: Vec<String>

Error chain (caused by).

custom_message: Option<String>

Custom message override.

Implementations

impl ConfigErrorDisplay

pub fn not_found(searched_path: impl Into<PathBuf>) -> Self

Create display for config file not found (E001).

pub fn read_error(file_path: impl Into<PathBuf>) -> Self

Create display for config read error (E002).

pub fn parse_error(file_path: impl Into<PathBuf>) -> Self

Create display for TOML parse error (E003).

pub fn validation_error(file_path: impl Into<PathBuf>) -> Self

Create display for validation error (E004).

pub fn env_error(var_name: impl Into<String>) -> Self

Create display for environment variable error (E005).

pub fn profile_not_found(profile_name: impl Into<String>) -> Self

Create display for profile not found error (E006).

pub fn no_workers(config_path: impl Into<PathBuf>) -> Self

Create display for no workers configured error (E007).

pub fn invalid_worker(worker_id: impl Into<String>) -> Self

Create display for invalid worker error (E008).

pub fn ssh_key_error(key_path: impl Into<PathBuf>) -> Self

Create display for SSH key error (E009).

pub fn socket_path_error(socket_path: impl Into<PathBuf>) -> Self

Create display for socket path error (E010).

pub fn line(self, line: usize) -> Self

Set the line number.

pub fn column(self, column: usize) -> Self

Set the column number.

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

Set the key path within the config.

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

Set a single-line snippet.

pub fn snippet_from_content(self, content: &str, context_lines: usize) -> Self

Set a multi-line snippet from file content.

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

Set the expected type/value.

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

Set the actual type/value found.

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

Set an example of a valid value.

pub fn search_paths( self, paths: impl IntoIterator<Item = impl Into<PathBuf>>, ) -> Self

Set config search paths.

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

Set the environment variable value.

pub fn permission( self, current: impl Into<String>, required: impl Into<String>, ) -> Self

Set permission mode info.

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

Set the raw error message.

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

Set a custom message.

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

Add a caused-by entry.

pub fn from_toml_error(self, error: &Error) -> Self

Set location from a toml parse error.

pub fn from_io_error(self, error: &Error) -> Self

Set location from an IO error.

pub fn to_error_panel(&self) -> ErrorPanel

Convert to an ErrorPanel for rendering.

pub fn render(&self, ctx: OutputContext)

Render the error to stderr.

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

Serialize to JSON string.

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

Serialize to compact JSON string.

Trait Implementations

impl Clone for ConfigErrorDisplay

fn clone(&self) -> ConfigErrorDisplay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigErrorDisplay

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigErrorDisplay

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ConfigErrorDisplay

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

Formats the value using the given formatter.

impl Error for ConfigErrorDisplay

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 Serialize for ConfigErrorDisplay

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

where __S: Serializer,

Serialize this value into the given Serde serializer.