donet_core/datagram/mod.rs
1/*
2 This file is part of Donet.
3
4 Copyright © 2024 Max Rodriguez <[email protected]>
5
6 Donet is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Affero General Public License,
8 as published by the Free Software Foundation, either version 3
9 of the License, or (at your option) any later version.
10
11 Donet is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Affero General Public License for more details.
15
16 You should have received a copy of the GNU Affero General Public
17 License along with Donet. If not, see <https://www.gnu.org/licenses/>.
18*/
19
20//! This module provides [`datagram::Datagram`] and [`iterator::DatagramIterator`].
21//!
22//! Solutions provided by this module:
23//!
24//! - Constructing datagrams with appropriate headers and payloads.
25//! - Iterating through and extracting information from received datagrams.
26//! - Converting endianness of datagram bytes to native byte order.
27//! - Datagram-level error handling.
28
29pub mod byte_order;
30pub mod datagram;
31pub mod iterator;