Struct ErrorContext 

pub struct ErrorContext {
    pub error: AgpmError,
    pub suggestion: Option<String>,
    pub details: Option<String>,
}

Error context wrapper that provides user-friendly error information

ErrorContext wraps a AgpmError and adds optional user-friendly messages, suggestions for resolution, and additional details. This is the primary way AGPM presents errors to CLI users.

Design Philosophy

Error contexts are designed to be:

• Actionable: Include specific suggestions for resolving the error
• Informative: Provide context about why the error occurred
• Colorized: Use terminal colors to highlight important information
• Consistent: Follow a standard format across all error types

Display Format

When displayed, errors show:

1. Error: The main error message in red
2. Details: Additional context about the error in yellow (optional)
3. Suggestion: Actionable steps to resolve the issue in green (optional)

Examples

Creating Error Context

use agpm_cli::core::{AgpmError, ErrorContext};

let error = AgpmError::GitNotFound;
let context = ErrorContext::new(error)
    .with_suggestion("Install git from https://git-scm.com/")
    .with_details("AGPM requires git for repository operations");

// Display to terminal with colors
context.display();

// Or convert to string for logging
let message = context.to_string();

Builder Pattern Usage

use agpm_cli::core::{AgpmError, ErrorContext};

let context = ErrorContext::new(AgpmError::ManifestNotFound)
    .with_suggestion("Create a agpm.toml file in your project directory")
    .with_details("AGPM searches current and parent directories for agpm.toml");

println!("{}", context);

Quick Suggestion Creation

use agpm_cli::core::ErrorContext;

// Create context with just a suggestion (useful for generic errors)
let context = ErrorContext::suggestion("Try running the command with --verbose");

Fields

error: AgpmError

The underlying AGPM error

suggestion: Option<String>

Optional suggestion for resolving the error

details: Option<String>

Optional additional details about the error

Implementations

impl ErrorContext

pub const fn new(error: AgpmError) -> Self

Create a new error context from a AgpmError

This creates a basic error context with no additional suggestions or details. Use the builder methods with_suggestion and with_details to add user-friendly information.

Examples

use agpm_cli::core::{AgpmError, ErrorContext};

let context = ErrorContext::new(AgpmError::GitNotFound);

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

Add a suggestion for resolving the error

Suggestions should be actionable steps that users can take to resolve the error. They are displayed in green in the terminal to draw attention.

Examples

use agpm_cli::core::{AgpmError, ErrorContext};

let context = ErrorContext::new(AgpmError::GitNotFound)
    .with_suggestion("Install git using 'brew install git' or visit https://git-scm.com/");

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

Add additional details explaining the error

Details provide context about why the error occurred or what it means. They are displayed in yellow in the terminal to provide additional context without being as prominent as the main error or suggestion.

Examples

use agpm_cli::core::{AgpmError, ErrorContext};

let context = ErrorContext::new(AgpmError::ManifestNotFound)
    .with_details("AGPM looks for agpm.toml in current directory and parent directories");

pub fn display(&self)

Display the error context to stderr with terminal colors

This method prints the error, details, and suggestion to stderr using color coding:

• Error message: Red and bold
• Details: Yellow
• Suggestion: Green

This is the primary way AGPM presents errors to users in the CLI.

Examples

use agpm_cli::core::{AgpmError, ErrorContext};

let context = ErrorContext::new(AgpmError::GitNotFound)
    .with_suggestion("Install git from https://git-scm.com/")
    .with_details("AGPM requires git for repository operations");

context.display(); // Prints colored error to stderr

impl ErrorContext

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

Create an ErrorContext with only a suggestion (no specific error)

This is useful for generic errors where you want to provide a suggestion but don’t have a specific AgpmError variant.

Examples

use agpm_cli::core::ErrorContext;

let context = ErrorContext::suggestion("Try running with --verbose for more information");
context.display();

Trait Implementations

impl Debug for ErrorContext

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

Formats the value using the given formatter.

impl Display for ErrorContext

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

Formats the value using the given formatter.

impl Error for ErrorContext

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.