bp3d_net/udp/
util.rs

1// Copyright (c) 2025, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8//     * Redistributions of source code must retain the above copyright notice,
9//       this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above copyright notice,
11//       this list of conditions and the following disclaimer in the documentation
12//       and/or other materials provided with the distribution.
13//     * Neither the name of BlockProject 3D nor the names of its contributors
14//       may be used to endorse or promote products derived from this software
15//       without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29//! Utility module for UDP client or server.
30
31use std::net::SocketAddr;
32use std::ops::Deref;
33
34/// An UDP datagram.
35pub struct Datagram<'a> {
36    peer_addr: SocketAddr,
37    buffer: &'a [u8],
38}
39
40impl<'a> Datagram<'a> {
41    /// Creates a new [Datagram].
42    ///
43    /// # Arguments
44    ///
45    /// * `peer_addr`: the address of the peer this datagram comes from or is intended for.
46    /// * `buffer`: the data buffer.
47    ///
48    /// returns: Datagram
49    pub fn new(peer_addr: SocketAddr, buffer: &'a [u8]) -> Self {
50        Self { peer_addr, buffer }
51    }
52
53    /// Returns the address of the peer this datagram comes from or is intended for.
54    pub fn peer_addr(&self) -> &SocketAddr {
55        &self.peer_addr
56    }
57}
58
59impl Deref for Datagram<'_> {
60    type Target = [u8];
61
62    fn deref(&self) -> &Self::Target {
63        self.buffer
64    }
65}
bp3d_net/udp/util.rs

bp3d_net/udp/
util.rs
