Custom error types in Rust

Introduction

Custom error types help you describe problems in your program clearly. They make it easier to find and fix mistakes.

When you want to explain specific problems in your code.

When you need to handle different errors in different ways.

When you want to give helpful messages to users or developers.

When you want to organize errors neatly in your program.

Syntax

Rust

enum MyError {
    NotFound,
    InvalidInput(String),
    ConnectionFailed,
}

Use enum to list all possible errors.

You can add extra information inside errors using parentheses.

Examples

This error type shows two simple errors: file not found and no permission.

Rust

enum FileError {
    NotFound,
    PermissionDenied,
}

This error type includes a message for invalid format and a simple empty input error.

Rust

enum ParseError {
    InvalidFormat(String),
    EmptyInput,
}

This error type has a general Other case with a message for unexpected errors.

Rust

enum NetworkError {
    Timeout,
    Disconnected,
    Other(String),
}

Sample Program

This program defines a custom error type MyError with two cases. It checks numbers and returns errors if the number is zero or negative. The main function shows how errors print friendly messages.

Rust

use std::fmt;

// Define a custom error type
enum MyError {
    NotFound,
    InvalidInput(String),
}

// Implement Display to show error messages
impl fmt::Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            MyError::NotFound => write!(f, "Item not found"),
            MyError::InvalidInput(msg) => write!(f, "Invalid input: {}", msg),
        }
    }
}

// A function that returns a Result with our custom error
fn check_value(value: i32) -> Result<(), MyError> {
    if value < 0 {
        Err(MyError::InvalidInput("negative number".to_string()))
    } else if value == 0 {
        Err(MyError::NotFound)
    } else {
        Ok(())
    }
}

fn main() {
    let values = [10, 0, -5];
    for &v in &values {
        match check_value(v) {
            Ok(()) => println!("Value {} is okay", v),
            Err(e) => println!("Error for value {}: {}", v, e),
        }
    }
}

Important Notes

Implementing Display helps show clear error messages.

Use Result<T, E> to return success or your custom error.

Custom errors make your code easier to understand and fix.

Summary

Custom error types describe specific problems in your program.

Use enums to list different errors with optional extra details.

Implement Display to show friendly messages when errors happen.

Practice

1. What is the main purpose of creating a custom error type in Rust?

easy

A. To automatically fix bugs in the code.

B. To make the program run faster by avoiding errors.

C. To replace the need for using Result types.

D. To describe specific problems in your program with clear error messages.

Solution

1. Step 1: Understand the role of custom errors

   Custom error types help programmers describe specific problems clearly in their code.

2. Step 2: Compare with other options

   Custom errors do not speed up code, fix bugs automatically, or replace Result types; they provide clear error descriptions.

3. Final Answer:

   To describe specific problems in your program with clear error messages. -> Option D

4. Quick Check:

   Custom error purpose = clear problem description [OK]

Hint: Custom errors explain problems clearly, not fix or speed up code [OK]

Common Mistakes:

• Thinking custom errors fix bugs automatically
• Confusing custom errors with performance improvements
• Believing custom errors replace Result types

2. Which of the following is the correct way to start defining a custom error enum in Rust?

easy

A. enum MyError { Io(std::io::Error), Parse(std::num::ParseIntError) }

B. struct MyError { message: String }

C. fn MyError() -> Error {}

D. class MyError { error: String }

Solution

1. Step 1: Identify Rust enum syntax

   Rust uses enum to define custom error types with variants, like Io(std::io::Error).

2. Step 2: Check other options

   struct is for data structures, fn is for functions, and class is not Rust syntax.

3. Final Answer:

   enum MyError { Io(std::io::Error), Parse(std::num::ParseIntError) } -> Option A

4. Quick Check:

   Custom error enum = enum with variants [OK]

Hint: Custom errors use enum with variants, not struct or class [OK]

Common Mistakes:

• Using struct instead of enum for error variants
• Trying to define errors as functions
• Using class keyword which is invalid in Rust

3. What will be the output of this Rust code snippet?

use std::fmt;

#[derive(Debug)]
enum MyError {
    NotFound,
    PermissionDenied,
}

impl fmt::Display for MyError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            MyError::NotFound => write!(f, "Item not found"),
            MyError::PermissionDenied => write!(f, "Permission denied"),
        }
    }
}

fn main() {
    let err = MyError::NotFound;
    println!("Error: {}", err);
}

medium

A. Error: NotFound

B. Error: Item not found

C. Error: Permission denied

D. Compilation error due to missing trait

Solution

1. Step 1: Understand Display implementation

   The fmt method matches MyError::NotFound and writes "Item not found" to the formatter.

2. Step 2: Check main output

   Printing err with {} uses Display, so output is "Error: Item not found".

3. Final Answer:

   Error: Item not found -> Option B

4. Quick Check:

   Display prints custom message = "Item not found" [OK]

Hint: Display trait controls {} output, matching variant message shown [OK]

Common Mistakes:

• Expecting Debug output instead of Display
• Confusing variant name with message
• Assuming compilation error without Display trait

4. Identify the error in this custom error implementation:

enum MyError {
    Io(std::io::Error),
}

impl std::fmt::Display for MyError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

medium

A. Cannot access self.0 because enum variant is not destructured.

B. Missing implementation of Debug trait.

C. Display trait cannot be implemented for enums.

D. write! macro requires a string literal, not a variable.

Solution

1. Step 1: Check how self.0 is accessed

   In an enum, you cannot directly access self.0 without matching or destructuring the variant.

2. Step 2: Understand correct pattern

   You must match self to get the inner std::io::Error value before using it in write!.

3. Final Answer:

   Cannot access self.0 because enum variant is not destructured. -> Option A

4. Quick Check:

   Enum variant fields need matching before access [OK]

Hint: Match enum variants before accessing inner fields [OK]

Common Mistakes:

• Trying to access enum fields directly without match
• Thinking Display can't be implemented for enums
• Assuming Debug trait is mandatory for Display

5. You want to create a custom error type that can hold either an IO error or a parsing error, and provide user-friendly messages. Which of these is the best complete approach?

hard

A. Create separate error structs for IO and parse errors without enums, and use panic! for messages.

B. Use a struct with two optional fields for IO and parse errors, and implement Display only.

C. Define an enum with variants for each error type, implement Display with match arms for messages, and implement std::error::Error.

D. Use a type alias for Result with String errors and skip custom error types.

Solution

1. Step 1: Choose enum for multiple error types

   An enum cleanly groups different error variants like IO and parse errors.

2. Step 2: Implement Display and std::error::Error traits

   Display provides friendly messages; implementing std::error::Error integrates with Rust error handling.

3. Final Answer:

   Define an enum with variants for each error type, implement Display with match arms for messages, and implement std::error::Error. -> Option C

4. Quick Check:

   Enum + Display + Error trait = best custom error pattern [OK]

Hint: Use enum + Display + Error trait for best custom error design [OK]

Common Mistakes:

• Using struct with optional fields causing confusion
• Skipping std::error::Error trait implementation
• Using panic! instead of proper error handling