iperf3-rs 1.0.0

Rust API for libiperf with live iperf3 metrics export
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Error types returned by the public library API.

use std::error::Error as StdError;
use std::fmt;

/// Result type used by the public iperf3-rs library API.
pub type Result<T> = std::result::Result<T, Error>;

/// Broad category for an [`Error`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ErrorKind {
    /// The supplied iperf or iperf3-rs argument was invalid.
    InvalidArgument,
    /// The requested metrics mode is not valid.
    InvalidMetricsMode,
    /// Upstream libiperf reported an error.
    Libiperf,
    /// Pushgateway configuration or delivery failed.
    PushGateway,
    /// Writing metrics file output failed.
    MetricsFile,
    /// The background iperf worker failed before producing a normal result.
    Worker,
    /// An internal synchronization or setup invariant failed.
    Internal,
}

/// Error returned by the public library API.
#[derive(Debug)]
pub struct Error {
    kind: ErrorKind,
    message: String,
    source: Option<Box<dyn StdError + Send + Sync + 'static>>,
}

impl Error {
    /// Create an error with a category and message.
    pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self {
        Self {
            kind,
            message: message.into(),
            source: None,
        }
    }

    /// Return the broad error category.
    pub fn kind(&self) -> ErrorKind {
        self.kind
    }

    /// Return the human-readable error message.
    pub fn message(&self) -> &str {
        &self.message
    }

    pub(crate) fn invalid_argument(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::InvalidArgument, message)
    }

    pub(crate) fn invalid_metrics_mode(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::InvalidMetricsMode, message)
    }

    pub(crate) fn libiperf(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::Libiperf, message)
    }

    #[cfg(feature = "pushgateway")]
    pub(crate) fn pushgateway(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::PushGateway, message)
    }

    pub(crate) fn worker(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::Worker, message)
    }

    pub(crate) fn internal(message: impl Into<String>) -> Self {
        Self::new(ErrorKind::Internal, message)
    }

    #[cfg(any(feature = "pushgateway", feature = "serde"))]
    pub(crate) fn with_source(
        kind: ErrorKind,
        message: impl Into<String>,
        source: impl StdError + Send + Sync + 'static,
    ) -> Self {
        Self {
            kind,
            message: message.into(),
            source: Some(Box::new(source)),
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.message)
    }
}

impl StdError for Error {
    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        self.source
            .as_deref()
            .map(|source| source as &(dyn StdError + 'static))
    }
}