Enum GcopError 

pub enum GcopError {
    Git(GitErrorWrapper),
    GitCommand(String),
    Config(String),
    Llm(String),
    LlmStreamTruncated {
        provider: String,
        detail: String,
    },
    LlmContentBlocked {
        provider: String,
        reason: String,
    },
    LlmTimeout {
        provider: String,
        detail: String,
    },
    LlmConnectionFailed {
        provider: String,
        detail: String,
    },
    LlmApi {
        status: u16,
        message: String,
    },
    Network(Error),
    Io(Error),
    Serde(Error),
    ConfigParse(ConfigError),
    Inquire(InquireError),
    NoStagedChanges,
    UserCancelled,
    InvalidInput(String),
    MaxRetriesExceeded(usize),
    SplitCommitPartial {
        completed: usize,
        total: usize,
        detail: String,
    },
    SplitParseFailed(String),
    Other(String),
}

gcop-rs unified error types

Contains all possible error conditions, supporting:

• Internationalized error messages (via localized_message())
• User-friendly solution suggestions (via localized_suggestion())
• Automatic conversion from various library errors (implementing From<T>)

Error category

• Git operation errors: GitCommand, Git
• LLM related errors: Llm, LlmApi
• Configuration errors: Config, ConfigParse
• User operations: UserCancelled, InvalidInput
• Others: Io, Network, Other

Example

use gcop_rs::error::{GcopError, Result};

fn example() -> Result<()> {
    let err = GcopError::NoStagedChanges;
    println!("Error: {}", err.localized_message());
    if let Some(suggestion) = err.localized_suggestion() {
        println!("Suggestion: {}", suggestion);
    }
    Err(err)
}

Variants

Git(GitErrorWrapper)

Git2 library error (libgit2)

Contains detailed ErrorCode and ErrorClass.

Common error codes

• NotFound: file/branch does not exist
• Exists: branch already exists
• Uncommitted: There are uncommitted changes
• Conflict: merge conflict

GitCommand(String)

Git command execution failed

Contains the stderr output of the git command.

Common reasons

• No staged changes: nothing to commit
• pre-commit hook failed
• merge conflicts

Config(String)

Configuration error

Including configuration file errors, environment variable errors, missing API keys, etc.

Llm(String)

LLM provider error

Generic LLM errors (non-HTTP status code errors).

Common reasons

• Response parsing failed
• No candidates/choices in response

LlmStreamTruncated

LLM stream unexpectedly truncated

The streaming response ended without a proper termination signal (e.g. no message_stop from Claude, no [DONE] from OpenAI).

Fields

provider: String

Provider name (e.g. “Claude”, “OpenAI”)

detail: String

Description of the truncation

LlmContentBlocked

LLM response blocked by content policy

The provider refused to generate a response due to safety filters (e.g. Gemini SAFETY or RECITATION finish reason).

Fields

provider: String

Provider name (e.g. “Gemini”)

reason: String

Reason reported by the provider

LlmTimeout

LLM request timeout

The HTTP request to the LLM API timed out before receiving a response.

Fields

provider: String

Provider name (e.g. “Claude”, “OpenAI”)

detail: String

Error detail from the HTTP client

LlmConnectionFailed

LLM connection failed

Could not establish a connection to the LLM API endpoint.

Fields

provider: String

Provider name (e.g. “Claude”, “OpenAI”)

detail: String

Error detail from the HTTP client

LlmApi

LLM API HTTP Error

Contains HTTP status codes and error messages.

Common status codes

• 401 - API key is invalid or expired
• 429 - rate limit
• 500+ - Server error

Fields

status: u16

HTTP status code

message: String

error message

Network(Error)

network error

HTTP request failed (timeout, DNS error, connection refused, etc.).

Io(Error)

IO error

File reading and writing failed.

Serde(Error)

serialization error

JSON serialization/deserialization failed.

ConfigParse(ConfigError)

Configuration file parsing error

The TOML file is malformed or the field types do not match.

Inquire(InquireError)

UI interaction errors

Terminal interaction failed (user input error, terminal unavailable, etc.).

NoStagedChanges

No staged changes

The staging area is empty and the commit message cannot be generated.

UserCancelled

User cancels operation

The user chooses to exit at the interactive prompt.

InvalidInput(String)

Invalid input

The user-supplied parameter does not conform to the expected format.

MaxRetriesExceeded(usize)

Maximum number of retries reached

The number of commit message generation retries exceeds the configured upper limit.

SplitCommitPartial

Split commit partially failed.

Some commit groups succeeded while a later group failed.

Fields

completed: usize

Number of groups that committed successfully.

total: usize

Total number of groups.

detail: String

Error detail.

SplitParseFailed(String)

Split response parsing failed.

The LLM response could not be parsed as valid commit groups.

Other(String)

Common error types

Used for errors that do not fit into other categories.

Implementations

impl GcopError

pub fn localized_message(&self) -> String

Get localized error messages

Returns a translated error message based on the current locale.

Returns

Localized error message string

Example

use gcop_rs::error::GcopError;

let err = GcopError::NoStagedChanges;
println!("{}", err.localized_message());
// Output: No staged changes found (English environment)
// Output: No staged changes found (Chinese environment)

pub fn localized_suggestion(&self) -> Option<String>

Get localized solutions

Returns user-friendly resolution suggestions based on the error type (if any).

Returns

• Some(suggestion) - solution suggestion string
• None - no specific suggestions

Suggestion type

• NoStagedChanges: Prompt to run git add
• Config(API key): Prompt to set API key
• LlmApi(401): Prompt to check API key validity
• LlmApi(429): Prompt to try again later or upgrade the API plan
• Network: Prompt to check network connection
• Other errors: may return None

Example

use gcop_rs::error::GcopError;

let err = GcopError::NoStagedChanges;
if let Some(suggestion) = err.localized_suggestion() {
    println!("Try: {}", suggestion);
}
// Output: Try: Run 'git add <files>' to stage your changes first

Trait Implementations

impl Debug for GcopError

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

Formats the value using the given formatter.

impl Display for GcopError

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

Formats the value using the given formatter.

impl Error for GcopError

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<ConfigError> for GcopError

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for GcopError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GcopError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GcopError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GcopError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InquireError> for GcopError

fn from(source: InquireError) -> Self

Converts to this type from the input type.