hyperion_framework/network/
serialiser.rs

1// -------------------------------------------------------------------------------------------------
2// Hyperion Framework
3// https://github.com/robert-hannah/hyperion-framework
4//
5// A lightweight component-based TCP framework for building service-oriented Rust applications with
6// CLI control, async messaging, and lifecycle management.
7//
8// Copyright 2025 Robert Hannah
9//
10// Licensed under the Apache License, Version 2.0 (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14//     http://www.apache.org/licenses/LICENSE-2.0
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21// -------------------------------------------------------------------------------------------------
22
23// Package
24use serde::{Serialize, de::DeserializeOwned};
25use serde_json;
26
27// Serialises any message into a byte vector (JSON format).
28pub fn serialise_message<T: Serialize>(msg: &T) -> Result<Vec<u8>, serde_json::Error> {
29    serde_json::to_vec(msg)
30}
31
32// Deserialises a byte slice into any message type.
33pub fn deserialise_message<T: DeserializeOwned>(data: &[u8]) -> Result<T, serde_json::Error> {
34    serde_json::from_slice(data)
35}
36
37// Example usages:
38// Serialise
39// let payload = match serialiser::serialise_message(&message) {
40//      Ok(payload) => payload,
41//      Err(e) => {
42//          log::error!("Failed to serialise message: {e:?} \n{message:?}");
43//          continue; // Skip this message and try the next one
44//      }
45// };
46
47// Deserialise
48// match serialiser::deserialise_message(&message) {
49//      Ok(payload) => payload
50//      Err(e) => {
51//          log::warn!("Message (raw): {}", String::from_utf8_lossy(&message));
52//          log::error!("Failed to deserialise message: {e:?}");
53//      }
54// }
hyperion_framework/network/serialiser.rs

hyperion_framework/network/
serialiser.rs
