#error-context #sqlx #path #query #debugging #error-handling

sqlx-error

A wrapper around sqlx::Error to provide error path and additional context

6 releases (breaking)

0.5.0 Jul 24, 2024
0.4.0 Sep 5, 2023
0.3.0 Sep 5, 2023
0.2.0 Jul 24, 2023
0.1.1 Jun 11, 2023

#630 in Filesystem

Download history 30/week @ 2024-06-27 5/week @ 2024-07-04 25/week @ 2024-07-11 88/week @ 2024-07-18 107/week @ 2024-07-25 10/week @ 2024-08-01 6/week @ 2024-08-08 8/week @ 2024-08-15 8/week @ 2024-08-22 6/week @ 2024-08-29 4/week @ 2024-09-05 47/week @ 2024-09-12 40/week @ 2024-09-19 25/week @ 2024-09-26 22/week @ 2024-10-03 16/week @ 2024-10-10

106 downloads per month

MIT license

6KB

License Crates.io Docs.rs

sqlx-error

A wrapper around sqlx::Error to provide error path and additional context.

Usage

use sqlx_error::{sqlx_error, SqlxError};

#[derive(Debug, thiserror::Error)]
pub enum MyError {
    #[error(transparent)]
    Sqlx(#[from] SqlxError),
}

/// If you have a single sqlx query per function, the function path by itself could provide
/// enough context
fn foo() -> Result<(), MyError> {
    Err(sqlx::Error::RowNotFound).map_err(sqlx_error!())?;
    Ok(())
}

/// Or you can add more context
fn bar() -> Result<(), MyError> {
    Err(sqlx::Error::RowNotFound).map_err(sqlx_error!("more context"))?;
    Ok(())
}

assert_eq!(foo().unwrap_err().to_string(), "sqlx rust_out::foo, src/lib.rs:15:43");
assert_eq!(bar().unwrap_err().to_string(), "sqlx rust_out::bar, src/lib.rs:21:43, more context");

Contributing

We appreciate all kinds of contributions, thank you!

Note on README

Most of the readme is automatically copied from the crate documentation by cargo-sync-readme. This way the readme is always in sync with the docs and examples are tested.

So if you find a part of the readme you'd like to change between <!-- cargo-sync-readme start --> and <!-- cargo-sync-readme end --> markers, don't edit README.md directly, but rather change the documentation on top of src/lib.rs and then synchronize the readme with:

cargo sync-readme

(make sure the cargo command is installed):

cargo install cargo-sync-readme

If you have rusty-hook installed the changes will apply automatically on commit.

License

This project is licensed under the MIT license.

Dependencies

~9MB
~165K SLoC