libpt_net/lib.rs
1//! # various networking tools
2//!
3//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
4//! module.
5//!
6//! The networking module contains various tools related to connections. For example, it contains a
7//! tool that has the purpose to check if your connection is consistently available.
8
9//// ATTRIBUTES ////////////////////////////////////////////////////////////////////////////////////
10// we want docs
11#![warn(missing_docs)]
12#![warn(rustdoc::missing_crate_level_docs)]
13////////////////////////////////////////////////////////////////////////////////////////////////////
14// we want Debug everywhere.
15#![warn(missing_debug_implementations)]
16////////////////////////////////////////////////////////////////////////////////////////////////////
17// enable clippy's extra lints, the pedantic version
18#![warn(clippy::pedantic)]
19
20//// IMPORTS ///////////////////////////////////////////////////////////////////////////////////////
21/// monitor your connection
22pub mod monitoring;
23
24//// CONSTANTS /////////////////////////////////////////////////////////////////////////////////////
25/// how long to wait for a remove server to respond in ms
26pub const DEFAULT_REQUEST_TIMEOUT: u64 = 2000;
27
28//// STATICS ///////////////////////////////////////////////////////////////////////////////////////
29
30//// MACROS ////////////////////////////////////////////////////////////////////////////////////////
31
32//// ENUMS /////////////////////////////////////////////////////////////////////////////////////////
33
34//// STRUCTS ///////////////////////////////////////////////////////////////////////////////////////
35
36//// IMPLEMENTATION ////////////////////////////////////////////////////////////////////////////////
37
38//// PUBLIC FUNCTIONS //////////////////////////////////////////////////////////////////////////////
39
40//// PRIVATE FUNCTIONS /////////////////////////////////////////////////////////////////////////////