Enum RailError 

pub enum RailError {
    Config(ConfigError),
    Git(GitError),
    Io(Error),
    Message {
        message: String,
        context: Option<String>,
        help: Option<String>,
    },
    CheckHasPendingChanges,
    ExitWithCode {
        code: i32,
    },
}

Main error type for cargo-rail

Variants

Config(ConfigError)

Configuration errors

Git(GitError)

Git operation errors

Io(Error)

I/O errors

Message

Generic error with message and optional context

Fields

message: String

Error message

context: Option<String>

Additional context about the error

help: Option<String>

Help text to guide the user

CheckHasPendingChanges

Check mode found pending changes (not an error, but exits with code 1)

Used by –check commands to signal that changes would be made. This is not a failure, but CI should treat it as “action needed”.

ExitWithCode

Exit with specific code (no error message printed)

Used for:

• Propagating subprocess exit codes (e.g., cargo test failures)
• Silent exits after JSON output has been written
• Any case where we need a specific exit code without error output

Fields

code: i32

The exit code to use

Implementations

impl RailError

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

Create a simple error message

pub fn with_help(msg: impl Into<String>, help: impl Into<String>) -> Self

Create an error with help text

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

Add context to an existing error

pub fn exit_code(&self) -> ExitCode

Get the appropriate exit code for this error

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

Get contextual help message for this error

Trait Implementations

impl Debug for RailError

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

Formats the value using the given formatter.

impl Display for RailError

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

Formats the value using the given formatter.

impl Error for RailError

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<&str> for RailError

fn from(msg: &str) -> Self

Converts to this type from the input type.

impl From<Error> for RailError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RailError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RailError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RailError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RailError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for RailError

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for RailError

fn from(err: ParseIntError) -> Self

Converts to this type from the input type.

impl From<String> for RailError

fn from(msg: String) -> Self

Converts to this type from the input type.

impl From<StripPrefixError> for RailError

fn from(err: StripPrefixError) -> Self

Converts to this type from the input type.

impl From<TomlError> for RailError

fn from(err: TomlError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for RailError

fn from(err: Utf8Error) -> Self

Converts to this type from the input type.

impl From<VarError> for RailError

fn from(err: VarError) -> Self

Converts to this type from the input type.