Skip to content

feat: make sure the error kind is properly transferred when serializing io errors #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 11, 2025
Merged

feat: make sure the error kind is properly transferred when serializing io errors #111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
166faea
make sure the error kind is properly transferred when serializing io …
rklaehn Jul 11, 2025
0ca18ce
Remove InvalidFilename because of MSRV.
rklaehn Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 175 additions & 10 deletions src/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,108 @@ pub mod serde {
use std::{fmt, io};

use serde::{
de::{self, Visitor},
de::{self, SeqAccess, Visitor},
ser::SerializeTuple,
Deserializer, Serializer,
};

fn error_kind_to_u8(kind: io::ErrorKind) -> u8 {
match kind {
io::ErrorKind::AddrInUse => 0,
io::ErrorKind::AddrNotAvailable => 1,
io::ErrorKind::AlreadyExists => 2,
io::ErrorKind::ArgumentListTooLong => 3,
io::ErrorKind::BrokenPipe => 4,
io::ErrorKind::ConnectionAborted => 5,
io::ErrorKind::ConnectionRefused => 6,
io::ErrorKind::ConnectionReset => 7,
io::ErrorKind::CrossesDevices => 8,
io::ErrorKind::Deadlock => 9,
io::ErrorKind::DirectoryNotEmpty => 10,
io::ErrorKind::ExecutableFileBusy => 11,
io::ErrorKind::FileTooLarge => 12,
io::ErrorKind::HostUnreachable => 13,
io::ErrorKind::Interrupted => 14,
io::ErrorKind::InvalidData => 15,
io::ErrorKind::InvalidInput => 17,
io::ErrorKind::IsADirectory => 18,
io::ErrorKind::NetworkDown => 19,
io::ErrorKind::NetworkUnreachable => 20,
io::ErrorKind::NotADirectory => 21,
io::ErrorKind::NotConnected => 22,
io::ErrorKind::NotFound => 23,
io::ErrorKind::NotSeekable => 24,
io::ErrorKind::Other => 25,
io::ErrorKind::OutOfMemory => 26,
io::ErrorKind::PermissionDenied => 27,
io::ErrorKind::QuotaExceeded => 28,
io::ErrorKind::ReadOnlyFilesystem => 29,
io::ErrorKind::ResourceBusy => 30,
io::ErrorKind::StaleNetworkFileHandle => 31,
io::ErrorKind::StorageFull => 32,
io::ErrorKind::TimedOut => 33,
io::ErrorKind::TooManyLinks => 34,
io::ErrorKind::UnexpectedEof => 35,
io::ErrorKind::Unsupported => 36,
io::ErrorKind::WouldBlock => 37,
io::ErrorKind::WriteZero => 38,
_ => 25,
}
}

fn u8_to_error_kind(num: u8) -> io::ErrorKind {
match num {
0 => io::ErrorKind::AddrInUse,
1 => io::ErrorKind::AddrNotAvailable,
2 => io::ErrorKind::AlreadyExists,
3 => io::ErrorKind::ArgumentListTooLong,
4 => io::ErrorKind::BrokenPipe,
5 => io::ErrorKind::ConnectionAborted,
6 => io::ErrorKind::ConnectionRefused,
7 => io::ErrorKind::ConnectionReset,
8 => io::ErrorKind::CrossesDevices,
9 => io::ErrorKind::Deadlock,
10 => io::ErrorKind::DirectoryNotEmpty,
11 => io::ErrorKind::ExecutableFileBusy,
12 => io::ErrorKind::FileTooLarge,
13 => io::ErrorKind::HostUnreachable,
14 => io::ErrorKind::Interrupted,
15 => io::ErrorKind::InvalidData,
// 16 => io::ErrorKind::InvalidFilename,
17 => io::ErrorKind::InvalidInput,
18 => io::ErrorKind::IsADirectory,
19 => io::ErrorKind::NetworkDown,
20 => io::ErrorKind::NetworkUnreachable,
21 => io::ErrorKind::NotADirectory,
22 => io::ErrorKind::NotConnected,
23 => io::ErrorKind::NotFound,
24 => io::ErrorKind::NotSeekable,
25 => io::ErrorKind::Other,
26 => io::ErrorKind::OutOfMemory,
27 => io::ErrorKind::PermissionDenied,
28 => io::ErrorKind::QuotaExceeded,
29 => io::ErrorKind::ReadOnlyFilesystem,
30 => io::ErrorKind::ResourceBusy,
31 => io::ErrorKind::StaleNetworkFileHandle,
32 => io::ErrorKind::StorageFull,
33 => io::ErrorKind::TimedOut,
34 => io::ErrorKind::TooManyLinks,
35 => io::ErrorKind::UnexpectedEof,
36 => io::ErrorKind::Unsupported,
37 => io::ErrorKind::WouldBlock,
38 => io::ErrorKind::WriteZero,
_ => io::ErrorKind::Other,
}
}

pub fn serialize<S>(error: &io::Error, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
// Serialize the error kind and message
serializer.serialize_str(&format!("{:?}:{}", error.kind(), error))
let mut tup = serializer.serialize_tuple(2)?;
tup.serialize_element(&error_kind_to_u8(error.kind()))?;
tup.serialize_element(&error.to_string())?;
tup.end()
}

pub fn deserialize<'de, D>(deserializer: D) -> Result<io::Error, D::Error>
Expand All @@ -33,20 +125,93 @@ pub mod serde {
type Value = io::Error;

fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str("an io::Error string representation")
formatter.write_str("a tuple of (u32, String) representing io::Error")
}

fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
fn visit_seq<A>(self, mut seq: A) -> Result<Self::Value, A::Error>
where
E: de::Error,
A: SeqAccess<'de>,
{
// For simplicity, create a generic error
// In a real app, you might want to parse the kind from the string
Ok(io::Error::other(value))
let num: u8 = seq
.next_element()?
.ok_or_else(|| de::Error::invalid_length(0, &self))?;
let message: String = seq
.next_element()?
.ok_or_else(|| de::Error::invalid_length(1, &self))?;
let kind = u8_to_error_kind(num);
Ok(io::Error::new(kind, message))
}
}

deserializer.deserialize_str(IoErrorVisitor)
deserializer.deserialize_tuple(2, IoErrorVisitor)
}
}

#[cfg(test)]
mod tests {
use std::io::{self, ErrorKind};

use postcard;
use serde::{Deserialize, Serialize};

use super::io_error_serde;

#[derive(Serialize, Deserialize)]
struct TestError(#[serde(with = "io_error_serde")] io::Error);

#[test]
fn test_roundtrip_error_kinds() {
let message = "test error";
let kinds = [
ErrorKind::AddrInUse,
ErrorKind::AddrNotAvailable,
ErrorKind::AlreadyExists,
ErrorKind::ArgumentListTooLong,
ErrorKind::BrokenPipe,
ErrorKind::ConnectionAborted,
ErrorKind::ConnectionRefused,
ErrorKind::ConnectionReset,
ErrorKind::CrossesDevices,
ErrorKind::Deadlock,
ErrorKind::DirectoryNotEmpty,
ErrorKind::ExecutableFileBusy,
ErrorKind::FileTooLarge,
ErrorKind::HostUnreachable,
ErrorKind::Interrupted,
ErrorKind::InvalidData,
// ErrorKind::InvalidFilename,
ErrorKind::InvalidInput,
ErrorKind::IsADirectory,
ErrorKind::NetworkDown,
ErrorKind::NetworkUnreachable,
ErrorKind::NotADirectory,
ErrorKind::NotConnected,
ErrorKind::NotFound,
ErrorKind::NotSeekable,
ErrorKind::Other,
ErrorKind::OutOfMemory,
ErrorKind::PermissionDenied,
ErrorKind::QuotaExceeded,
ErrorKind::ReadOnlyFilesystem,
ErrorKind::ResourceBusy,
ErrorKind::StaleNetworkFileHandle,
ErrorKind::StorageFull,
ErrorKind::TimedOut,
ErrorKind::TooManyLinks,
ErrorKind::UnexpectedEof,
ErrorKind::Unsupported,
ErrorKind::WouldBlock,
ErrorKind::WriteZero,
];

for kind in kinds {
let err = TestError(io::Error::new(kind, message));
let serialized = postcard::to_allocvec(&err).unwrap();
let deserialized: TestError = postcard::from_bytes(&serialized).unwrap();

assert_eq!(err.0.kind(), deserialized.0.kind());
assert_eq!(err.0.to_string(), deserialized.0.to_string());
}
}
}
}
Expand Down
Loading