1use serde::{de::DeserializeOwned, Serialize};
2
3use crate::Envelope;
4
5#[derive(Debug, thiserror::Error)]
6pub enum CodecError {
7 #[error("postcard encode failed: {0}")]
8 PostcardEncode(postcard::Error),
9 #[error("postcard decode failed: {0}")]
10 PostcardDecode(postcard::Error),
11 #[error("bincode encode failed: {0}")]
12 BincodeEncode(bincode::Error),
13 #[error("bincode decode failed: {0}")]
14 BincodeDecode(bincode::Error),
15}
16
17pub trait Codec {
18 fn encode<T: Serialize>(&self, value: &T) -> Result<Vec<u8>, CodecError>;
19 fn decode<T: DeserializeOwned>(&self, bytes: &[u8]) -> Result<T, CodecError>;
20}
21
22#[derive(Debug, Clone, Copy, Default)]
24pub struct PostcardCodec;
25
26impl Codec for PostcardCodec {
27 fn encode<T: Serialize>(&self, value: &T) -> Result<Vec<u8>, CodecError> {
28 postcard::to_allocvec(value).map_err(CodecError::PostcardEncode)
29 }
30
31 fn decode<T: DeserializeOwned>(&self, bytes: &[u8]) -> Result<T, CodecError> {
32 postcard::from_bytes(bytes).map_err(CodecError::PostcardDecode)
33 }
34}
35
36#[derive(Debug, Clone, Copy, Default)]
38pub struct BincodeCodec;
39
40impl Codec for BincodeCodec {
41 fn encode<T: Serialize>(&self, value: &T) -> Result<Vec<u8>, CodecError> {
42 bincode::serialize(value).map_err(CodecError::BincodeEncode)
43 }
44
45 fn decode<T: DeserializeOwned>(&self, bytes: &[u8]) -> Result<T, CodecError> {
46 bincode::deserialize(bytes).map_err(CodecError::BincodeDecode)
47 }
48}
49
50pub fn encode_envelope<T: Serialize>(
51 codec: &impl Codec,
52 payload: T,
53) -> Result<Vec<u8>, CodecError> {
54 codec.encode(&Envelope::new(payload))
55}
56
57pub fn decode_envelope<T: DeserializeOwned>(
58 codec: &impl Codec,
59 bytes: &[u8],
60) -> Result<Envelope<T>, CodecError> {
61 codec.decode(bytes)
62}
63
64#[cfg(test)]
65mod tests {
66 use super::*;
67 use crate::types::{
68 BlueprintIngredientView, BlueprintView, EntityState, TickDelta, ToolRequirementView,
69 Transform, WorldClock, WorldCoord,
70 };
71
72 fn sample_tick_delta() -> TickDelta {
73 TickDelta {
74 tick: 42,
75 entities: (0..15)
76 .map(|i| EntityState {
77 id: i + 1,
78 label: String::new(),
79 transform: Transform {
80 position: WorldCoord::surface(i as f32, i as f32 * 0.5),
81 yaw: 1.25,
82 velocity: crate::types::Velocity2D { vx: 0.5, vy: -0.2 },
83 },
84 vitals: None,
85 attributes: None,
86 skills: None,
87 inside_building: None,
88 tile_id: None,
89 paperdoll_ref: None,
90 presentation_state: None,
91 sprite_mode: None,
92 progression_xp: None,
93 combat_cues: Vec::new(),
94 statuses: Vec::new(),
95 })
96 .collect(),
97 resource_nodes: Vec::new(),
98 buildings: Vec::new(),
99 doors: Vec::new(),
100 npcs: Vec::new(),
101 inventory: Vec::new(),
102 blueprints: Vec::new(),
103 building_materials: Vec::new(),
104 world_clock: WorldClock::default(),
105 ground_drops: Vec::new(),
106 placed_containers: Vec::new(),
107 combat: None,
108 interior_map: None,
109 quest_log: vec![],
110 hired_workers: Vec::new(),
111 interactables: vec![],
112 ledger: None,
113 career: None,
114 combat_fx: Vec::new(),
115 property_plots: Vec::new(),
116 terrain_overlays: Vec::new(),
117 }
118 }
119
120 #[test]
121 fn postcard_blueprint_snapshot_roundtrip() {
122 let codec = PostcardCodec;
123 let delta = TickDelta {
124 tick: 1,
125 entities: vec![],
126 resource_nodes: vec![],
127 buildings: vec![],
128 doors: vec![],
129 npcs: vec![],
130 inventory: vec![],
131 blueprints: vec![BlueprintView {
132 id: "oak_to_lumber".into(),
133 label: "Saw Planks".into(),
134 output: "lumber".into(),
135 output_qty: 1,
136 craft_ticks: 60,
137 station: Some("woodworking".into()),
138 category: Some("woodworking".into()),
139 required_tools: vec![ToolRequirementView {
140 item: "handsaw".into(),
141 consumed: false,
142 display_name: "Handsaw".into(),
143 }],
144 skill: None,
145 failure_chance: 0.0,
146 worker_train_copper: 0,
147 output_display_name: "Lumber".into(),
148 inputs: vec![BlueprintIngredientView {
149 template_id: "oak_log".into(),
150 quantity: 2,
151 consumed: true,
152 display_name: "Oak Log".into(),
153 }],
154 }],
155 building_materials: Vec::new(),
156 world_clock: WorldClock::default(),
157 ground_drops: vec![],
158 placed_containers: vec![],
159 combat: None,
160 interior_map: None,
161 quest_log: vec![],
162 hired_workers: Vec::new(),
163 interactables: vec![],
164 ledger: None,
165 career: None,
166 combat_fx: Vec::new(),
167 property_plots: Vec::new(),
168 terrain_overlays: Vec::new(),
169 };
170 let bytes = codec.encode(&Envelope::new(delta.clone())).unwrap();
171 let decoded: Envelope<TickDelta> = codec.decode(&bytes).unwrap();
172 assert_eq!(decoded.payload, delta);
173 }
174
175 #[test]
176 fn postcard_roundtrip_tick_delta() {
177 let codec = PostcardCodec;
178 let original = Envelope::new(sample_tick_delta());
179 let bytes = codec.encode(&original).expect("encode");
180 let decoded: Envelope<TickDelta> = codec.decode(&bytes).expect("decode");
181 assert_eq!(original, decoded);
182 }
183
184 #[test]
185 fn bincode_roundtrip_tick_delta() {
186 let codec = BincodeCodec;
187 let original = Envelope::new(sample_tick_delta());
188 let bytes = codec.encode(&original).expect("encode");
189 let decoded: Envelope<TickDelta> = codec.decode(&bytes).expect("decode");
190 assert_eq!(original, decoded);
191 }
192
193 #[test]
194 fn postcard_many_entities_vitals_none() {
195 let delta = TickDelta {
196 tick: 42,
197 entities: (0..15)
198 .map(|i| EntityState {
199 id: i + 1,
200 label: String::new(),
201 transform: Transform {
202 position: WorldCoord::surface(i as f32, i as f32 * 0.5),
203 yaw: 1.25,
204 velocity: crate::types::Velocity2D { vx: 0.5, vy: -0.2 },
205 },
206 vitals: None,
207 attributes: None,
208 skills: None,
209 inside_building: None,
210 tile_id: None,
211 paperdoll_ref: None,
212 presentation_state: None,
213 sprite_mode: None,
214 progression_xp: None,
215 combat_cues: Vec::new(),
216 statuses: Vec::new(),
217 })
218 .collect(),
219 resource_nodes: vec![],
220 buildings: vec![],
221 doors: vec![],
222 npcs: vec![],
223 inventory: vec![],
224 blueprints: vec![],
225 building_materials: vec![],
226 world_clock: WorldClock::default(),
227 ground_drops: vec![],
228 placed_containers: vec![],
229 combat: None,
230 interior_map: None,
231 quest_log: vec![],
232 hired_workers: Vec::new(),
233 interactables: vec![],
234 ledger: None,
235 career: None,
236 combat_fx: Vec::new(),
237 property_plots: Vec::new(),
238 terrain_overlays: Vec::new(),
239 };
240 let codec = PostcardCodec;
241 let bytes = codec.encode(&Envelope::new(delta.clone())).unwrap();
242 let decoded: Envelope<TickDelta> = codec.decode(&bytes).unwrap();
243 assert_eq!(decoded.payload, delta);
244 }
245}