bacnet-rs 0.3.1

BACnet protocol stack implementation in Rust
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
109
110
111
112
113
114

//! Configuration and builder for the high-level BACnet client.
//!
//! [`ClientConfig`] holds the parameters used to construct a
//! [`BacnetClient`](super::BacnetClient): the local interface/port to bind, the
//! per-request timeout, and how many times to retry. Use
//! [`BacnetClient::builder`](super::BacnetClient::builder) to construct a client
//! fluently:
//!
//! ```rust,no_run
//! use bacnet_rs::client::BacnetClient;
//! use std::time::Duration;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let client = BacnetClient::builder()
//!     .local_addr("0.0.0.0")
//!     .port(0)
//!     .timeout(Duration::from_secs(3))
//!     .retries(2)
//!     .build()?;
//! # let _ = client;
//! # Ok(())
//! # }
//! ```

use std::time::Duration;

use super::{BacnetClient, ClientError};

/// Default per-request timeout used when none is configured.
pub const DEFAULT_TIMEOUT: Duration = Duration::from_secs(5);

/// Default host to bind to (all interfaces, OS-assigned ephemeral port).
pub const DEFAULT_HOST: &str = "0.0.0.0";

/// Configuration parameters for a [`BacnetClient`](super::BacnetClient).
///
/// Construct one via [`BacnetClient::builder`](super::BacnetClient::builder)
/// rather than directly; the builder applies sensible defaults.
#[derive(Debug, Clone)]
pub struct ClientConfig {
    /// Local host/interface to bind the UDP socket to.
    pub host: String,
    /// Local UDP port to bind. `0` lets the OS assign an ephemeral port.
    pub port: u16,
    /// How long to wait for a response before giving up.
    pub timeout: Duration,
    /// Number of times to retry a request after the first attempt times out.
    ///
    /// Currently stored for use by later request paths; the existing methods
    /// do not yet retry.
    pub retries: u8,
}

impl Default for ClientConfig {
    fn default() -> Self {
        Self {
            host: DEFAULT_HOST.to_string(),
            port: 0,
            timeout: DEFAULT_TIMEOUT,
            retries: 0,
        }
    }
}

impl ClientConfig {
    /// The address string (`host:port`) the socket will bind to.
    pub fn bind_addr(&self) -> String {
        format!("{}:{}", self.host, self.port)
    }
}

/// Fluent builder for a [`BacnetClient`](super::BacnetClient).
///
/// Obtain one from [`BacnetClient::builder`](super::BacnetClient::builder).
#[derive(Debug, Clone, Default)]
pub struct ClientBuilder {
    config: ClientConfig,
}

impl ClientBuilder {
    /// Create a builder with default configuration.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the local host/interface to bind to (default `"0.0.0.0"`).
    pub fn local_addr(mut self, host: impl Into<String>) -> Self {
        self.config.host = host.into();
        self
    }

    /// Set the local UDP port to bind (default `0`, an OS-assigned port).
    pub fn port(mut self, port: u16) -> Self {
        self.config.port = port;
        self
    }

    /// Set the per-request timeout (default 5 seconds).
    pub fn timeout(mut self, timeout: Duration) -> Self {
        self.config.timeout = timeout;
        self
    }

    /// Set the number of retries after an initial timeout (default `0`).
    pub fn retries(mut self, retries: u8) -> Self {
        self.config.retries = retries;
        self
    }

    /// Consume the builder and bind the client's socket.
    pub fn build(self) -> Result<BacnetClient, ClientError> {
        BacnetClient::from_config(self.config)
    }
}