6 releases
Uses new Rust 2024
new 0.1.6 | May 15, 2025 |
---|---|
0.1.5 | May 15, 2025 |
0.1.2 | Apr 21, 2025 |
#1161 in Encoding
302 downloads per month
Used in 2 crates
14KB
53 lines
cdumay_error_toml
A lightweight utility crate that wraps TOML serialization and deserialization errors (toml::ser::Error
, toml::de::Error
) and converts them into structured, typed errors using the cdumay_error
framework.
This helps standardize error handling in Rust applications that process TOML configuration or data files, while enriching error details with structured context.
Features
- Categorizes TOML-related errors into
Serialization
andDeserialization
- Provides unique error codes, HTTP status codes, and descriptions
- Supports rich contextual error metadata via
BTreeMap
- Uses the
cdumay_error::ErrorConverter
trait for easy integration - Provides a convenient macros for error conversion
Usage Example
Dependencies
[dependencies]
cdumay_error = "0.2"
serde = { version = "1.0", features = ["derive"] }
serde-value = "0.7"
toml = "0.8"
Code sample
Using the TomlDeserializeErrorConverter
and TomlSerializeErrorConverter
directly:
use cdumay_error::ErrorConverter;
use std::collections::BTreeMap;
use serde::{Deserialize, Serialize};
use cdumay_error_toml::{TomlDeserializeErrorConverter, TomlSerializeErrorConverter};
#[derive(Serialize, Deserialize)]
struct Config {
name: String,
debug: bool,
}
fn serialize_config(config: &Config) -> Result<String, cdumay_error::Error> {
toml::to_string(config).map_err(|e| {
let mut ctx = BTreeMap::new();
ctx.insert("config_name".into(), serde_value::Value::String(config.name.clone()));
TomlSerializeErrorConverter::convert(&e, "Failed to serialize TOML config".into(), ctx)
})
}
fn deserialize_config(input: &str) -> Result<Config, cdumay_error::Error> {
toml::from_str::<Config>(input).map_err(|e| {
let mut ctx = BTreeMap::new();
ctx.insert("input".into(), serde_value::Value::String(input.to_string()));
TomlDeserializeErrorConverter::convert(&e, "Failed to deserialize TOML config".into(), ctx)
})
}
Example Output
{
"code": "TOML-00001",
"status": 400,
"kind": "Invalid Toml data",
"message": "Failed to deserialize TOML config",
"context": {
"input": "[invalid toml]"
}
}
Using the macros:
use cdumay_error::ErrorConverter;
use std::collections::BTreeMap;
use serde::{Deserialize, Serialize};
use cdumay_error_toml::{convert_deserialize_result, convert_serialize_result};
#[derive(Serialize, Deserialize)]
struct Config {
name: String,
debug: bool,
}
fn serialize_config(config: &Config) -> Result<String, cdumay_error::Error> {
let mut ctx = BTreeMap::new();
ctx.insert("config_name".into(), serde_value::Value::String(config.name.clone()));
convert_serialize_result!(toml::to_string(config), ctx, "Failed to serialize TOML config")
}
fn deserialize_config(input: &str) -> Result<Config, cdumay_error::Error> {
let mut ctx = BTreeMap::new();
ctx.insert("input".into(), serde_value::Value::String(input.to_string()));
convert_deserialize_result!(toml::from_str::<Config>(input), ctx, "Failed to deserialize TOML config")
}
Dependencies
~0.7–1.3MB
~29K SLoC