Skip to main content

tokio_multicast/
error.rs

1use std::fmt::{Display, Formatter};
2use std::io;
3use std::net::{IpAddr, SocketAddr};
4
5#[derive(Debug)]
6pub enum MulticastError {
7    InvalidGroupAddress(IpAddr),
8    UnsupportedOption(&'static str),
9    BindAddressRequired,
10    NoMembershipsConfigured,
11    BindFailed { addr: SocketAddr, source: io::Error },
12    Io(io::Error),
13}
14
15impl Display for MulticastError {
16    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
17        match self {
18            Self::InvalidGroupAddress(addr) => write!(f, "invalid multicast group address: {addr}"),
19            Self::UnsupportedOption(option) => write!(f, "unsupported multicast option: {option}"),
20            Self::BindAddressRequired => write!(f, "bind address is required"),
21            Self::NoMembershipsConfigured => write!(f, "at least one multicast membership is required"),
22            Self::BindFailed { addr, source } => write!(f, "failed to bind {addr}: {source}"),
23            Self::Io(source) => Display::fmt(source, f),
24        }
25    }
26}
27
28impl std::error::Error for MulticastError {
29    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
30        match self {
31            Self::BindFailed { source, .. } | Self::Io(source) => Some(source),
32            _ => None,
33        }
34    }
35}
36
37impl From<io::Error> for MulticastError {
38    fn from(value: io::Error) -> Self {
39        Self::Io(value)
40    }
41}
42
43pub type Result<T> = std::result::Result<T, MulticastError>;