Enum NetworkError

#[non_exhaustive]
pub enum NetworkError {
    BindFailure,
    CommonClient(CommonNetClientNetworkError),
    CommonNet(CommonNetNetworkError),
    ExpectedData,
    FSEmul(FSEmulNetworkError),
    HTTP(Error),
    IO(Error),
    ListInterfacesFailure(Error),
    LocalIp(Error),
    Parse(NetworkParseError),
    SetBroadcastFailure,
    SendQueueMessageFailure(SendError<ResponseStreamMessage>),
    Timeout(Duration),
}

Trying to interact with the network has resulted in an error.

NOTE: this does not cover bogus data coming in from the network. This only covers errors related to interacting with the network. If you’re looking for bogus data from the network errors look at NetworkParseError.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BindFailure

We failed to bind to a local address to listen for packets from the network.

This can happen for numerous reason, such as:

• The program does not have permission to listen on this specific port.
• The address is already being used by another process.
• The network interface returned some type of error.

There are multiple other cases, but in general they’re pretty OS specific.

CommonClient(CommonNetClientNetworkError)

CommonNet(CommonNetNetworkError)

An error has occurred in our common network framework.

ExpectedData

FSEmul(FSEmulNetworkError)

HTTP(Error)

See reqwest::Error for details.

IO(Error)

See tokio::io::Error for details.

ListInterfacesFailure(Error)

See network_interface::Error::GetIfAddrsError for details.

LocalIp(Error)

See local_ip_address::Error for details.

Parse(NetworkParseError)

See NetworkParseError for details.

SetBroadcastFailure

If we failed to call setsockopt through libc.

For example if on linux see: https://linux.die.net/man/2/setsockopt

SendQueueMessageFailure(SendError<ResponseStreamMessage>)

Error adding a packet to a queue to send.

Timeout(Duration)

We waited too long to send/receive data from the network.

There may be something wrong with our network connection, or the targets network connection.

Trait Implementations

impl Debug for NetworkError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Diagnostic for NetworkError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for NetworkError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for NetworkError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<CommonNetClientNetworkError> for NetworkError

fn from(source: CommonNetClientNetworkError) -> Self

Converts to this type from the input type.

impl From<CommonNetNetworkError> for NetworkError

fn from(source: CommonNetNetworkError) -> Self

Converts to this type from the input type.

impl From<Error> for NetworkError

fn from(source: ReqwestError) -> Self

Converts to this type from the input type.

impl From<Error> for NetworkError

fn from(source: IoError) -> Self

Converts to this type from the input type.

impl From<Error> for NetworkError

fn from(source: LocalIpAddressError) -> Self

Converts to this type from the input type.

impl From<FSEmulNetworkError> for NetworkError

fn from(source: FSEmulNetworkError) -> Self

Converts to this type from the input type.

impl From<FSEmulProtocolError> for NetworkError

fn from(value: FSEmulProtocolError) -> Self

Converts to this type from the input type.

impl From<MIONCGIErrors> for NetworkError

fn from(value: MIONCGIErrors) -> Self

Converts to this type from the input type.

impl From<MIONControlProtocolError> for NetworkError

fn from(value: MIONControlProtocolError) -> Self

Converts to this type from the input type.

impl From<MIONParamProtocolError> for NetworkError

fn from(value: MIONParamProtocolError) -> Self

Converts to this type from the input type.

impl From<MIONProtocolError> for NetworkError

fn from(value: MIONProtocolError) -> Self

Converts to this type from the input type.

impl From<NetworkError> for CatBridgeError

fn from(source: NetworkError) -> Self

Converts to this type from the input type.

impl From<NetworkParseError> for NetworkError

fn from(source: NetworkParseError) -> Self

Converts to this type from the input type.

impl From<SDIONetworkError> for NetworkError

fn from(value: SDIONetworkError) -> Self

Converts to this type from the input type.

impl From<SDIOProtocolError> for NetworkError

fn from(value: SDIOProtocolError) -> Self

Converts to this type from the input type.

impl From<SataProtocolError> for NetworkError

fn from(value: SataProtocolError) -> Self

Converts to this type from the input type.

impl From<SendError<ResponseStreamMessage>> for NetworkError

fn from(source: SendError<ResponseStreamMessage>) -> Self

Converts to this type from the input type.