Skip to content

refactor!: migrate from snafu/n0-snafu to n0-error #59

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
ramfox merged 17 commits into from
Nov 3, 2025
Merged

refactor!: migrate from snafu/n0-snafu to n0-error #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a3a516a
initial conversion by ChatGPT
Frando Oct 30, 2025
172614d
fixup
Frando Oct 31, 2025
77e1e99
chore: fmt
Frando Oct 31, 2025
1e13498
fixup
Frando Oct 31, 2025
3f3cecc
fixup
Frando Oct 31, 2025
55dd9a0
bump to released n0-error
Frando Oct 31, 2025
dcbd60a
fixup
Frando Oct 31, 2025
1fd3aa3
fixup
Frando Oct 31, 2025
8898537
deps: cargo update for wasm-bindgen issue
Frando Oct 31, 2025
646584b
fixup
Frando Oct 31, 2025
e28b33d
fix: cleanup and from_sources
Frando Oct 31, 2025
c606821
refactor: make use of from_sources
Frando Oct 31, 2025
84fe832
fixup
Frando Oct 31, 2025
ebcc3e3
deps: remove nested_enum_utils
Frando Oct 31, 2025
cca471e
fix: import ensure
Frando Nov 3, 2025
290d561
chore: update to n0-watcher 0.5.0
Frando Nov 3, 2025
29ed0df
deps: bump iroh-metrics
Frando Nov 3, 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
231 changes: 112 additions & 119 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions netwatch/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,10 @@ workspace = true
[dependencies]
atomic-waker = "1.1.2"
bytes = "1.7"
n0-error = "0.1.0"
n0-future = "0.3.0"
n0-watcher = "0.4.0"
nested_enum_utils = "0.2.3"
n0-watcher = "0.5.0"
pin-project-lite = "0.2.16"
snafu = "0.8.5"
time = "0.3.20"
tokio = { version = "1", features = [
"io-util",
Expand Down
104 changes: 52 additions & 52 deletions netwatch/src/interfaces/bsd.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ use libc::{AF_INET, AF_INET6, AF_LINK, AF_ROUTE, AF_UNSPEC, CTL_NET, c_int, uint
use libc::{
NET_RT_DUMP, RTA_IFP, RTAX_BRD, RTAX_DST, RTAX_GATEWAY, RTAX_MAX, RTAX_NETMASK, RTF_GATEWAY,
};
use nested_enum_utils::common_fields;
use snafu::{Backtrace, IntoError, OptionExt, Snafu};
use n0_error::{e, ensure, stack_error};
use tracing::warn;

use super::DefaultRouteDetails;
Expand Down Expand Up @@ -249,7 +248,7 @@ fn u16_from_ne_range(
data.get(range)
.and_then(|s| TryInto::<[u8; 2]>::try_into(s).ok())
.map(u16::from_ne_bytes)
.context(MessageTooShortSnafu)
.ok_or_else(|| e!(RouteError::MessageTooShort))
}

/// Safely convert some bytes from a slice into a u32.
Expand All @@ -260,7 +259,7 @@ fn u32_from_ne_range(
data.get(range)
.and_then(|s| TryInto::<[u8; 4]>::try_into(s).ok())
.map(u32::from_ne_bytes)
.context(MessageTooShortSnafu)
.ok_or_else(|| e!(RouteError::MessageTooShort))
}

impl WireFormat {
Expand All @@ -273,12 +272,12 @@ impl WireFormat {
target_os = "ios"
))]
MessageType::Route => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, ..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);
let attrs: i32 = u32_from_ne_range(data, 12..16)?
.try_into()
.map_err(|_| InvalidMessageSnafu.build())?;
.map_err(|_| e!(RouteError::InvalidMessage))?;
let addrs = parse_addrs(attrs, parse_kernel_inet_addr, &data[self.body_off..])?;
let mut m = RouteMessage {
version: data[2] as _,
Expand All @@ -300,11 +299,11 @@ impl WireFormat {
}
#[cfg(target_os = "openbsd")]
MessageType::Route => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, ..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);
let ll = u16_from_ne_range(data, 4..6)? as usize;
snafu::ensure!(data.len() >= ll as usize, InvalidMessageSnafu);
ensure!(data.len() >= ll as usize, RouteError::InvalidMessage);

let addrs = parse_addrs(
u32_from_ne_range(data, 12..16)? as _,
Expand All @@ -331,9 +330,9 @@ impl WireFormat {
Ok(Some(WireMessage::Route(m)))
}
MessageType::Interface => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, 0..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);

let attrs = u32_from_ne_range(data, 4..8)?;
if attrs as c_int & RTA_IFP == 0 {
Expand All @@ -354,9 +353,9 @@ impl WireFormat {
Ok(Some(WireMessage::Interface(m)))
}
MessageType::InterfaceAddr => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, ..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);

#[cfg(target_os = "netbsd")]
let index = u16_from_ne_range(data, 16..18)?;
Expand All @@ -379,9 +378,9 @@ impl WireFormat {
Ok(Some(WireMessage::InterfaceAddr(m)))
}
MessageType::InterfaceMulticastAddr => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, ..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);

let addrs = parse_addrs(
u32_from_ne_range(data, 4..8)? as _,
Expand All @@ -398,17 +397,17 @@ impl WireFormat {
Ok(Some(WireMessage::InterfaceMulticastAddr(m)))
}
MessageType::InterfaceAnnounce => {
snafu::ensure!(data.len() >= self.body_off, MessageTooShortSnafu);
ensure!(data.len() >= self.body_off, RouteError::MessageTooShort);
let l = u16_from_ne_range(data, ..2)?;
snafu::ensure!(data.len() >= l as usize, InvalidMessageSnafu);
ensure!(data.len() >= l as usize, RouteError::InvalidMessage);

let mut name = String::new();
for i in 0..16 {
if data[6 + i] != 0 {
continue;
}
name = std::str::from_utf8(&data[6..6 + i])
.map_err(|_| InvalidAddressSnafu.build())?
.map_err(|_| e!(RouteError::InvalidAddress))?
.to_string();
break;
}
Expand Down Expand Up @@ -446,9 +445,9 @@ struct RoutingStack {

/// Parses b as a routing information base and returns a list of routing messages.
pub fn parse_rib(typ: RIBType, data: &[u8]) -> Result<Vec<WireMessage>, RouteError> {
snafu::ensure!(
ensure!(
is_valid_rib_type(typ),
InvalidRibTypeSnafu { rib_type: typ }
RouteError::InvalidRibType { rib_type: typ }
);

let mut msgs = Vec::new();
Expand All @@ -459,8 +458,8 @@ pub fn parse_rib(typ: RIBType, data: &[u8]) -> Result<Vec<WireMessage>, RouteErr
while b.len() > 4 {
nmsgs += 1;
let l = u16_from_ne_range(b, ..2)?;
snafu::ensure!(l != 0, InvalidMessageSnafu);
snafu::ensure!(b.len() >= l as usize, MessageTooShortSnafu);
ensure!(l != 0, RouteError::InvalidMessage);
ensure!(b.len() >= l as usize, RouteError::MessageTooShort);
if b[2] as i32 != ROUTING_STACK.rtm_version {
// b = b[l:];
continue;
Expand All @@ -485,7 +484,7 @@ pub fn parse_rib(typ: RIBType, data: &[u8]) -> Result<Vec<WireMessage>, RouteErr
}

// We failed to parse any of the messages - version mismatch?
snafu::ensure!(nmsgs == msgs.len() + nskips, MessageMismatchSnafu);
ensure!(nmsgs == msgs.len() + nskips, RouteError::MessageMismatch);

Ok(msgs)
}
Expand Down Expand Up @@ -599,24 +598,22 @@ pub struct InterfaceAnnounceMessage {
/// Represents a type of routing information base.
type RIBType = i32;

#[common_fields({
backtrace: Option<Backtrace>,
})]
#[derive(Debug, Snafu)]
#[stack_error(derive, add_meta)]
#[non_exhaustive]
pub enum RouteError {
#[snafu(display("message mismatch"))]
#[error("message mismatch")]
MessageMismatch {},
#[snafu(display("message too short"))]
#[error("message too short")]
MessageTooShort {},
#[snafu(display("invalid message"))]
#[error("invalid message")]
InvalidMessage {},
#[snafu(display("invalid address"))]
#[error("invalid address")]
InvalidAddress {},
#[snafu(display("invalid rib type {rib_type}"))]
#[error("invalid rib type {rib_type}")]
InvalidRibType { rib_type: RIBType },
#[snafu(display("io error calling '{name}'"))]
#[error("io error calling '{name}'")]
Io {
#[error(std_err)]
source: std::io::Error,
name: &'static str,
},
Expand Down Expand Up @@ -649,7 +646,10 @@ fn fetch_rib(af: i32, typ: RIBType, arg: i32) -> Result<Vec<u8>, RouteError> {
)
};
if err != 0 {
return Err(IoSnafu { name: "sysctl" }.into_error(std::io::Error::last_os_error()));
return Err(e!(
RouteError::Io { name: "sysctl" },
std::io::Error::last_os_error()
));
}
if n == 0 {
// nothing available
Expand All @@ -675,7 +675,7 @@ fn fetch_rib(af: i32, typ: RIBType, arg: i32) -> Result<Vec<u8>, RouteError> {
if io_err.raw_os_error().unwrap_or_default() == libc::ENOMEM && round < MAX_TRIES {
continue;
}
return Err(IoSnafu { name: "sysctl" }.into_error(io_err));
return Err(e!(RouteError::Io { name: "sysctl" }, io_err));
}
// Truncate b, to the new length
b.truncate(n);
Expand Down Expand Up @@ -768,15 +768,15 @@ where
let a = parse_link_addr(b)?;
addrs.push(a);
let l = roundup(b[0] as usize);
snafu::ensure!(b.len() >= l, MessageTooShortSnafu);
ensure!(b.len() >= l, RouteError::MessageTooShort);
b = &b[l..];
}
AF_INET | AF_INET6 => {
let af = b[1] as i32;
let a = parse_inet_addr(af, b)?;
addrs.push(a);
let l = roundup(b[0] as usize);
snafu::ensure!(b.len() >= l, MessageTooShortSnafu);
ensure!(b.len() >= l, RouteError::MessageTooShort);
b = &b[l..];
}
_ => {
Expand All @@ -794,7 +794,7 @@ where
let a = parse_default_addr(b)?;
addrs.push(a);
let l = roundup(b[0] as usize);
snafu::ensure!(b.len() >= l, MessageTooShortSnafu);
ensure!(b.len() >= l, RouteError::MessageTooShort);
b = &b[l..];
}
}
Expand All @@ -809,19 +809,19 @@ where
fn parse_inet_addr(af: i32, b: &[u8]) -> Result<Addr, RouteError> {
match af {
AF_INET => {
snafu::ensure!(b.len() >= SIZEOF_SOCKADDR_INET, InvalidAddressSnafu);
ensure!(b.len() >= SIZEOF_SOCKADDR_INET, RouteError::InvalidAddress);

let ip = Ipv4Addr::new(b[4], b[5], b[6], b[7]);
Ok(Addr::Inet4 { ip })
}
AF_INET6 => {
snafu::ensure!(b.len() >= SIZEOF_SOCKADDR_INET6, InvalidAddressSnafu);
ensure!(b.len() >= SIZEOF_SOCKADDR_INET6, RouteError::InvalidAddress);

let mut zone = u32_from_ne_range(b, 24..28)?;
let mut oc: [u8; 16] = b
.get(8..24)
.and_then(|s| TryInto::<[u8; 16]>::try_into(s).ok())
.context(InvalidMessageSnafu)?;
.ok_or_else(|| e!(RouteError::InvalidMessage))?;
if oc[0] == 0xfe && oc[1] & 0xc0 == 0x80
|| oc[0] == 0xff && (oc[1] & 0x0f == 0x01 || oc[1] & 0x0f == 0x02)
{
Expand All @@ -834,7 +834,7 @@ fn parse_inet_addr(af: i32, b: &[u8]) -> Result<Addr, RouteError> {
.get(2..4)
.and_then(|s| TryInto::<[u8; 2]>::try_into(s).ok())
.map(u16::from_be_bytes)
.context(InvalidMessageSnafu)? as u32;
.ok_or_else(|| e!(RouteError::InvalidMessage))? as u32;
if id != 0 {
zone = id;
oc[2] = 0;
Expand All @@ -846,7 +846,7 @@ fn parse_inet_addr(af: i32, b: &[u8]) -> Result<Addr, RouteError> {
zone,
})
}
_ => Err(InvalidAddressSnafu.build()),
_ => Err(e!(RouteError::InvalidAddress)),
}
}

Expand Down Expand Up @@ -885,7 +885,7 @@ fn parse_kernel_inet_addr(af: i32, b: &[u8]) -> Result<(i32, Addr), RouteError>
l = roundup(l);
}

snafu::ensure!(b.len() >= l, InvalidAddressSnafu);
ensure!(b.len() >= l, RouteError::InvalidAddress);
// Don't reorder case expressions.
// The case expressions for IPv6 must come first.
const OFF4: usize = 4; // offset of in_addr
Expand All @@ -895,7 +895,7 @@ fn parse_kernel_inet_addr(af: i32, b: &[u8]) -> Result<(i32, Addr), RouteError>
let octets: [u8; 16] = b
.get(OFF6..OFF6 + 16)
.and_then(|s| TryInto::try_into(s).ok())
.context(InvalidMessageSnafu)?;
.ok_or_else(|| e!(RouteError::InvalidMessage))?;
let ip = Ipv6Addr::from(octets);
Addr::Inet6 { ip, zone: 0 }
} else if af == AF_INET6 {
Expand All @@ -911,7 +911,7 @@ fn parse_kernel_inet_addr(af: i32, b: &[u8]) -> Result<(i32, Addr), RouteError>
let octets: [u8; 4] = b
.get(OFF4..OFF4 + 4)
.and_then(|s| TryInto::try_into(s).ok())
.context(InvalidMessageSnafu)?;
.ok_or_else(|| e!(RouteError::InvalidMessage))?;
let ip = Ipv4Addr::from(octets);
Addr::Inet4 { ip }
} else {
Expand All @@ -930,7 +930,7 @@ fn parse_kernel_inet_addr(af: i32, b: &[u8]) -> Result<(i32, Addr), RouteError>
}

fn parse_link_addr(b: &[u8]) -> Result<Addr, RouteError> {
snafu::ensure!(b.len() >= 8, InvalidAddressSnafu);
ensure!(b.len() >= 8, RouteError::InvalidAddress);
let (_, mut a) = parse_kernel_link_addr(AF_LINK, &b[4..])?;

if let Addr::Link { index, .. } = &mut a {
Expand Down Expand Up @@ -972,12 +972,12 @@ fn parse_kernel_link_addr(_: i32, b: &[u8]) -> Result<(usize, Addr), RouteError>
}

let l = 4 + nlen + alen + slen;
snafu::ensure!(b.len() >= l, InvalidAddressSnafu);
ensure!(b.len() >= l, RouteError::InvalidAddress);
let mut data = &b[4..];

let name = if nlen > 0 {
let name = std::str::from_utf8(&data[..nlen])
.map_err(|_| InvalidAddressSnafu.build())?
.map_err(|_| e!(RouteError::InvalidAddress))?
.to_string();
data = &data[nlen..];
Some(name)
Expand All @@ -1001,9 +1001,9 @@ fn parse_kernel_link_addr(_: i32, b: &[u8]) -> Result<(usize, Addr), RouteError>
}

fn parse_default_addr(b: &[u8]) -> Result<Addr, RouteError> {
snafu::ensure!(
ensure!(
b.len() >= 2 && b.len() >= b[0] as usize,
InvalidAddressSnafu
RouteError::InvalidAddress
);
Ok(Addr::Default {
af: b[1] as _,
Expand Down
Loading
Loading