diff options
| author | Linus Färnstrand <linus@mullvad.net> | 2019-04-03 18:05:38 +0200 |
|---|---|---|
| committer | Linus Färnstrand <linus@mullvad.net> | 2019-04-05 16:28:05 +0200 |
| commit | 464b37f5bf3e3a1bdba1a8e52d52c5f6f6e30c92 (patch) | |
| tree | fd5536c96b4ed39975edfd5b256314b1ec191f75 | |
| parent | e13bf82221658d0dc0710a11c1cf2306b3999aa8 (diff) | |
| download | mullvadvpn-464b37f5bf3e3a1bdba1a8e52d52c5f6f6e30c92.tar.xz mullvadvpn-464b37f5bf3e3a1bdba1a8e52d52c5f6f6e30c92.zip | |
Add documentation to routing errors
| -rw-r--r-- | talpid-core/src/routing/linux.rs | 6 | ||||
| -rw-r--r-- | talpid-core/src/routing/macos.rs | 6 |
2 files changed, 12 insertions, 0 deletions
diff --git a/talpid-core/src/routing/linux.rs b/talpid-core/src/routing/linux.rs index 73de509a0e..b229b192c2 100644 --- a/talpid-core/src/routing/linux.rs +++ b/talpid-core/src/routing/linux.rs @@ -9,20 +9,26 @@ use std::{ pub type Result<T> = std::result::Result<T, Error>; +/// Errors that can happen in the Linux routing integration #[derive(err_derive::Error, Debug)] pub enum Error { + /// Failed to add route. #[error(display = "Failed to add route")] FailedToAddRoute(#[error(cause)] io::Error), + /// Failed to remove route. #[error(display = "Failed to remove route")] FailedToRemoveRoute(#[error(cause)] io::Error), + /// Error while running "ip route". #[error(display = "Error while running \"ip route\"")] FailedToRunIp(#[error(cause)] io::Error), + /// No default route in "ip route" output. #[error(display = "No default route in \"ip route\" output")] NoDefaultRoute, + /// Failed to parse default route as IP. #[error(display = "Failed to parse default route as IP: {}", _0)] ParseDefaultRoute(String, #[error(cause)] AddrParseError), } diff --git a/talpid-core/src/routing/macos.rs b/talpid-core/src/routing/macos.rs index d0e9497c1c..722efbb320 100644 --- a/talpid-core/src/routing/macos.rs +++ b/talpid-core/src/routing/macos.rs @@ -10,20 +10,26 @@ use std::{ pub type Result<T> = std::result::Result<T, Error>; +/// Errors that can happen in the macOS routing integration. #[derive(err_derive::Error, Debug)] pub enum Error { + /// Failed to add route. #[error(display = "Failed to add route")] FailedToAddRoute(#[error(cause)] io::Error), + /// Failed to remove route. #[error(display = "Failed to remove route")] FailedToRemoveRoute(#[error(cause)] io::Error), + /// Error while running "ip route". #[error(display = "Error while running \"ip route\"")] FailedToRunIp(#[error(cause)] io::Error), + /// No default route in "ip route" output. #[error(display = "No default route in \"ip route\" output")] NoDefaultRoute, + /// Failed to parse default route as IP. #[error(display = "Failed to parse default route as IP: {}", _0)] ParseDefaultRoute(String, #[error(cause)] AddrParseError), } |