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 draw_scale: 1.0,
91 presentation_state: None,
92 sprite_mode: None,
93 progression_xp: None,
94 combat_cues: Vec::new(),
95 statuses: Vec::new(),
96 })
97 .collect(),
98 resource_nodes: Vec::new(),
99 buildings: Vec::new(),
100 doors: Vec::new(),
101 npcs: Vec::new(),
102 inventory: Vec::new(),
103 blueprints: Vec::new(),
104 building_materials: Vec::new(),
105 world_clock: WorldClock::default(),
106 ground_drops: Vec::new(),
107 placed_containers: Vec::new(),
108 combat: None,
109 interior_map: None,
110 quest_log: vec![],
111 hired_workers: Vec::new(),
112 interactables: vec![],
113 ledger: None,
114 career: None,
115 combat_fx: Vec::new(),
116 property_plots: Vec::new(),
117 terrain_overlays: Vec::new(),
118 }
119 }
120
121 #[test]
122 fn postcard_blueprint_snapshot_roundtrip() {
123 let codec = PostcardCodec;
124 let delta = TickDelta {
125 tick: 1,
126 entities: vec![],
127 resource_nodes: vec![],
128 buildings: vec![],
129 doors: vec![],
130 npcs: vec![],
131 inventory: vec![],
132 blueprints: vec![BlueprintView {
133 id: "oak_to_lumber".into(),
134 label: "Saw Planks".into(),
135 output: "lumber".into(),
136 output_qty: 1,
137 craft_ticks: 60,
138 station: Some("woodworking".into()),
139 category: Some("woodworking".into()),
140 required_tools: vec![ToolRequirementView {
141 item: "handsaw".into(),
142 consumed: false,
143 display_name: "Handsaw".into(),
144 }],
145 skill: None,
146 failure_chance: 0.0,
147 worker_train_copper: 0,
148 output_display_name: "Lumber".into(),
149 inputs: vec![BlueprintIngredientView {
150 template_id: "oak_log".into(),
151 quantity: 2,
152 consumed: true,
153 display_name: "Oak Log".into(),
154 }],
155 }],
156 building_materials: Vec::new(),
157 world_clock: WorldClock::default(),
158 ground_drops: vec![],
159 placed_containers: vec![],
160 combat: None,
161 interior_map: None,
162 quest_log: vec![],
163 hired_workers: Vec::new(),
164 interactables: vec![],
165 ledger: None,
166 career: None,
167 combat_fx: Vec::new(),
168 property_plots: Vec::new(),
169 terrain_overlays: Vec::new(),
170 };
171 let bytes = codec.encode(&Envelope::new(delta.clone())).unwrap();
172 let decoded: Envelope<TickDelta> = codec.decode(&bytes).unwrap();
173 assert_eq!(decoded.payload, delta);
174 }
175
176 #[test]
177 fn postcard_roundtrip_tick_delta() {
178 let codec = PostcardCodec;
179 let original = Envelope::new(sample_tick_delta());
180 let bytes = codec.encode(&original).expect("encode");
181 let decoded: Envelope<TickDelta> = codec.decode(&bytes).expect("decode");
182 assert_eq!(original, decoded);
183 }
184
185 #[test]
186 fn bincode_roundtrip_tick_delta() {
187 let codec = BincodeCodec;
188 let original = Envelope::new(sample_tick_delta());
189 let bytes = codec.encode(&original).expect("encode");
190 let decoded: Envelope<TickDelta> = codec.decode(&bytes).expect("decode");
191 assert_eq!(original, decoded);
192 }
193
194 #[test]
195 fn postcard_many_entities_vitals_none() {
196 let delta = TickDelta {
197 tick: 42,
198 entities: (0..15)
199 .map(|i| EntityState {
200 id: i + 1,
201 label: String::new(),
202 transform: Transform {
203 position: WorldCoord::surface(i as f32, i as f32 * 0.5),
204 yaw: 1.25,
205 velocity: crate::types::Velocity2D { vx: 0.5, vy: -0.2 },
206 },
207 vitals: None,
208 attributes: None,
209 skills: None,
210 inside_building: None,
211 tile_id: None,
212 paperdoll_ref: None,
213 draw_scale: 1.0,
214 presentation_state: None,
215 sprite_mode: None,
216 progression_xp: None,
217 combat_cues: Vec::new(),
218 statuses: Vec::new(),
219 })
220 .collect(),
221 resource_nodes: vec![],
222 buildings: vec![],
223 doors: vec![],
224 npcs: vec![],
225 inventory: vec![],
226 blueprints: vec![],
227 building_materials: vec![],
228 world_clock: WorldClock::default(),
229 ground_drops: vec![],
230 placed_containers: vec![],
231 combat: None,
232 interior_map: None,
233 quest_log: vec![],
234 hired_workers: Vec::new(),
235 interactables: vec![],
236 ledger: None,
237 career: None,
238 combat_fx: Vec::new(),
239 property_plots: Vec::new(),
240 terrain_overlays: Vec::new(),
241 };
242 let codec = PostcardCodec;
243 let bytes = codec.encode(&Envelope::new(delta.clone())).unwrap();
244 let decoded: Envelope<TickDelta> = codec.decode(&bytes).unwrap();
245 assert_eq!(decoded.payload, delta);
246 }
247}