jomini 0.35.0

Low level, performance oriented parser for save and game files from EU4, CK3, HOI4, Vic3, Imperator, and other PDS titles
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
#![cfg(feature = "envelope")]
use jomini::{
    Encoding, Utf8Encoding,
    binary::{
        BinaryDeserializerBuilder, BinaryFlavor, Token, TokenResolver, de::BinaryReaderDeserializer,
    },
    envelope::{
        BinaryEncoding, EnvelopeErrorKind, JominiFile, JominiFileKind, SaveContent,
        SaveContentKind, SaveData, SaveDataKind, SaveHeaderKind, SaveMetadata, SaveMetadataKind,
    },
};
use rawzip::ReaderAt;
use serde::Deserialize;
use std::{collections::HashMap, io::Read};

#[derive(Debug, PartialEq, Deserialize)]
struct Meta {
    meta: bool,
}

#[derive(Debug, PartialEq, Deserialize)]
struct Gamestate {
    meta: bool,
    gamestate: String,
}

#[derive(Debug, PartialEq, Deserialize)]
struct BinaryMeta {
    meta: u32,
}

#[derive(Debug, PartialEq, Deserialize)]
struct BinaryGamestate {
    meta: u32,
    gamestate: u32,
}

// Expected test data - text format
const EXPECTED_TEXT_META: &str = "meta=yes\n";
const EXPECTED_TEXT_GAMESTATE: &str = "meta=yes\ngamestate=\"hi\"\n";

// Expected test data - binary format
const EXPECTED_BINARY_META_TOKENS: &[Token] =
    &[Token::Id(0x1000), Token::Equal, Token::U32(0xdddd)];

const EXPECTED_BINARY_GAMESTATE_TOKENS: &[Token] = &[
    Token::Id(0x1000),
    Token::Equal,
    Token::U32(0xdddd),
    Token::Id(0x2000),
    Token::Equal,
    Token::U32(0xffff),
];

const EXPECTED_BINARY_META: BinaryMeta = BinaryMeta { meta: 0xdddd };
const EXPECTED_BINARY_GAMESTATE: BinaryGamestate = BinaryGamestate {
    meta: 0xdddd,
    gamestate: 0xffff,
};

fn plaintext_uncompressed_assertions(file: JominiFile<impl ReaderAt>) {
    // We can unwrap the file and work more effectively with the data
    let JominiFileKind::Uncompressed(SaveDataKind::Text(data_txt)) = file.kind() else {
        panic!("expected text uncompressed envelope");
    };

    let expected_gamestate = Gamestate {
        meta: true,
        gamestate: "hi".to_string(),
    };

    // Can extract meta
    let mut meta = data_txt.meta();
    let mut buf = String::new();
    meta.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_META);

    // And deserialize it
    let meta: Meta = data_txt.meta().deserializer().deserialize().unwrap();
    assert_eq!(meta, Meta { meta: true });

    // Can read gamestate
    let mut gamestate = data_txt.body().cursor();
    let mut buf = String::new();
    gamestate.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_GAMESTATE);

    // Can deserialize gamestate
    let gamestate: Gamestate = data_txt.deserializer().deserialize().unwrap();
    assert_eq!(gamestate, expected_gamestate);

    // But we also don't have to unwrap it and instead can work with the file directly

    // Can extract meta
    let mut meta = file.meta().unwrap();
    let mut buf = String::new();
    meta.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_META);

    // Can deserialize meta
    let meta = file.meta().unwrap();
    let SaveMetadataKind::Text(mut meta_txt) = meta else {
        panic!("expected text meta");
    };
    let meta: Meta = meta_txt.deserializer().deserialize().unwrap();
    assert_eq!(meta, Meta { meta: true });

    let mut gamestate = file.gamestate().unwrap();
    let mut buf = String::new();
    gamestate.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_GAMESTATE);

    let gamestate = file.gamestate().unwrap();
    let SaveContentKind::Text(mut gamestate_txt) = gamestate else {
        panic!("expected text gamestate");
    };
    let gamestate: Gamestate = gamestate_txt.deserializer().deserialize().unwrap();
    assert_eq!(gamestate, expected_gamestate);
}

fn binary_uncompressed_assertions(file: JominiFile<impl ReaderAt>) {
    // We can unwrap the file and work more effectively with the data
    let JominiFileKind::Uncompressed(SaveDataKind::Binary(data_bin)) = file.kind() else {
        panic!("expected binary uncompressed envelope");
    };

    let resolver = HashMap::<u16, &str>::from([(0x1000, "meta"), (0x2000, "gamestate")]);

    // Can extract meta
    let meta = data_bin.meta();
    expected_tokens(EXPECTED_BINARY_META_TOKENS, meta);

    // Can extract meta and deserialize
    let mut meta = data_bin.meta();
    let actual: BinaryMeta = meta.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_META);

    // Can read gamestate
    let gamestate = data_bin.body().cursor();
    expected_tokens(EXPECTED_BINARY_GAMESTATE_TOKENS, gamestate);

    // Can binary deserialize gamestate
    let mut gamestate = data_bin.body().cursor();
    let actual: BinaryGamestate = BinaryDeserializerBuilder::with_flavor(TestFlavor)
        .from_reader(&mut gamestate, &resolver)
        .deserialize()
        .unwrap();
    assert_eq!(actual, EXPECTED_BINARY_GAMESTATE);

    // But we also don't have to unwrap it and instead can work with the file directly

    // Can extract meta
    let meta = file.meta().unwrap();
    expected_tokens(EXPECTED_BINARY_META_TOKENS, meta);

    // Can binary deserialize meta
    let SaveMetadataKind::Binary(mut meta) = file.meta().unwrap() else {
        panic!("expected binary meta");
    };
    let actual: BinaryMeta = meta.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_META);

    let gamestate = file.gamestate().unwrap();
    expected_tokens(EXPECTED_BINARY_GAMESTATE_TOKENS, gamestate);

    // Can binary deserialize gamestate
    let SaveContentKind::Binary(mut gamestate) = file.gamestate().unwrap() else {
        panic!("expected binary gamestate");
    };
    let actual: BinaryGamestate = gamestate.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_GAMESTATE);
}

#[test]
fn plaintext_extraction() {
    let file = std::fs::File::open("tests/fixtures/envelopes/text.txt").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::Text);
    plaintext_uncompressed_assertions(file);

    let file = std::fs::read("tests/fixtures/envelopes/text.txt").unwrap();
    let file = JominiFile::from_slice(&file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::Text);
    plaintext_uncompressed_assertions(file);
}

fn expected_tokens(expected: &[Token], reader: impl std::io::Read) {
    let mut reader = jomini::binary::TokenReader::new(reader);
    let mut i = 0;
    while let Some(token) = reader.next().unwrap() {
        let expected_token = &expected[i];
        assert_eq!(&token, expected_token);
        i += 1;
    }
    assert_eq!(i, expected.len());
}

fn zip_binary_assertions(file: &JominiFile<impl ReaderAt>) {
    // We can unwrap the file and work more effectively with the data
    let JominiFileKind::Zip(kind) = file.kind() else {
        panic!("expected zip binary envelope");
    };

    let resolver = HashMap::<u16, &str>::from([(0x1000, "meta"), (0x2000, "gamestate")]);

    // Can extract meta
    let meta = kind.meta().unwrap();
    expected_tokens(EXPECTED_BINARY_META_TOKENS, meta);

    // Can extract meta by matching on kind too
    let SaveMetadataKind::Binary(meta) = kind.meta().unwrap() else {
        panic!("expected binary meta");
    };

    expected_tokens(EXPECTED_BINARY_META_TOKENS, meta);

    // Can binary deserialize save meta
    let SaveMetadataKind::Binary(mut meta) = kind.meta().unwrap() else {
        panic!("expected binary meta");
    };
    let actual: BinaryMeta = meta.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_META);

    // Can read gamestate
    let gamestate = kind.gamestate().unwrap();
    expected_tokens(EXPECTED_BINARY_GAMESTATE_TOKENS, gamestate);

    // Can binary deserialize gamestate
    let SaveContentKind::Binary(mut gamestate) = kind.gamestate().unwrap() else {
        panic!("expected binary gamestate");
    };
    let actual: BinaryGamestate = gamestate.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_GAMESTATE);

    // But we also don't have to unwrap it and instead can work with the file directly

    // Can extract meta
    let meta = file.meta().unwrap();
    expected_tokens(EXPECTED_BINARY_META_TOKENS, meta);

    // Can binary deserialize meta
    let SaveMetadataKind::Binary(mut meta) = file.meta().unwrap() else {
        panic!("expected binary meta");
    };
    let actual: BinaryMeta = meta.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_META);

    let gamestate = file.gamestate().unwrap();
    expected_tokens(EXPECTED_BINARY_GAMESTATE_TOKENS, gamestate);

    // Can binary deserialize gamestate
    let SaveContentKind::Binary(mut gamestate) = file.gamestate().unwrap() else {
        panic!("expected binary gamestate");
    };
    let actual: BinaryGamestate = gamestate.deserializer(&resolver).deserialize().unwrap();
    assert_eq!(actual, EXPECTED_BINARY_GAMESTATE);
}

fn zip_text_assertions(file: JominiFile<impl ReaderAt>) {
    // We can unwrap the file and work more effectively with the data
    let JominiFileKind::Zip(kind) = file.kind() else {
        panic!("expected zip text envelope");
    };

    // Extract and validate metadata (ZIP text may have empty or actual metadata)
    let SaveMetadataKind::Text(mut meta) = kind.meta().unwrap() else {
        panic!("expected text meta");
    };
    // Just verify we can extract it, content may vary for ZIP text format
    let mut buf = String::new();
    let _ = meta.read_to_string(&mut buf);

    // Can extract gamestate
    let mut gamestate = kind.gamestate().unwrap();
    let mut buf = String::new();
    gamestate.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_GAMESTATE);

    // Can text deserialize gamestate
    let SaveContentKind::Text(mut gamestate) = kind.gamestate().unwrap() else {
        panic!("expected text gamestate");
    };
    let expected_gamestate = Gamestate {
        meta: true,
        gamestate: "hi".to_string(),
    };
    let actual: Gamestate = gamestate.deserializer().deserialize().unwrap();
    assert_eq!(actual, expected_gamestate);

    // But we also don't have to unwrap it and instead can work with the file directly

    // Can extract meta
    let SaveMetadataKind::Text(_meta) = file.meta().unwrap() else {
        panic!("expected text meta");
    };

    // Can deserialize meta
    let SaveMetadataKind::Text(mut meta_txt) = file.meta().unwrap() else {
        panic!("expected text meta");
    };
    let meta: Meta = meta_txt.deserializer().deserialize().unwrap();
    assert_eq!(meta, Meta { meta: true });

    let mut gamestate = file.gamestate().unwrap();
    let mut buf = String::new();
    gamestate.read_to_string(&mut buf).unwrap();
    assert_eq!(&buf, EXPECTED_TEXT_GAMESTATE);

    let SaveContentKind::Text(mut gamestate) = file.gamestate().unwrap() else {
        panic!("expected text gamestate");
    };
    let gamestate: Gamestate = gamestate.deserializer().deserialize().unwrap();
    assert_eq!(gamestate, expected_gamestate);
}

#[test]
fn zip_bin_compressed_meta() {
    let file = std::fs::File::open("tests/fixtures/envelopes/split.zip").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::SplitBinary);
    zip_binary_assertions(&file);

    let file = std::fs::read("tests/fixtures/envelopes/split.zip").unwrap();
    let file = JominiFile::from_slice(&file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::SplitBinary);
    zip_binary_assertions(&file);
}

#[test]
fn zip_bin_uncompressed_meta() {
    let file = std::fs::File::open("tests/fixtures/envelopes/header.zip").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedBinary);
    zip_binary_assertions(&file);

    let file = std::fs::read("tests/fixtures/envelopes/header.zip").unwrap();
    let file = JominiFile::from_slice(&file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedBinary);
    zip_binary_assertions(&file);
}

#[test]
fn bin_uncompressed() {
    // a file that mimics CK3 binary autosave
    let file = std::fs::File::open("tests/fixtures/envelopes/autosave.bin").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::Binary);
    binary_uncompressed_assertions(file);

    let file = std::fs::read("tests/fixtures/envelopes/autosave.bin").unwrap();
    let file = JominiFile::from_slice(&file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::Binary);
    binary_uncompressed_assertions(file);
}

#[test]
fn zip_txt() {
    // a file that mimics CK3 text autosave in ZIP
    let file = std::fs::File::open("tests/fixtures/envelopes/text.zip").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedText);
    zip_text_assertions(file);

    let file = std::fs::read("tests/fixtures/envelopes/text.zip").unwrap();
    let file = JominiFile::from_slice(&file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedText);
    zip_text_assertions(file);
}

#[test]
fn envelope_vec() {
    // test to ensure that passing in a Vec<u8> still has full functionality
    let file = std::fs::read("tests/fixtures/envelopes/text.zip").unwrap();
    let file = JominiFile::from_slice(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedText);
    zip_text_assertions(file);
}

#[test]
fn malformed_zip_doesnt_panic() {
    // Regression test for invalid metadata range with malformed ZIP central directory
    // This file has a ZIP with an invalid central directory offset that would previously
    // cause an integer underflow panic when accessing metadata
    let data = std::fs::read("tests/fixtures/envelopes/malformed_zip.bin").unwrap();
    let file = JominiFile::from_slice(&data).unwrap();

    let header = file.header();
    assert_eq!(header.kind(), SaveHeaderKind::UnifiedText);

    // Verify we can attempt to access metadata without panicking
    if let Ok(mut meta) = file.meta() {
        let _bytes_read = std::io::copy(&mut meta, &mut std::io::sink());
    }

    // Verify we can attempt to access gamestate without panicking
    if let Ok(mut gamestate) = file.gamestate() {
        let _bytes_read = std::io::copy(&mut gamestate, &mut std::io::sink());
    }
}

#[test]
fn txt_eu5_sav02() {
    let file = std::fs::File::open("tests/fixtures/envelopes/sav02.txt").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::Text);
    plaintext_uncompressed_assertions(file);
}

#[test]
fn zip_eu5_sav02() {
    // EU5 1.0.8 introduce a new save format with a string lookup file stored separately
    let file = std::fs::File::open("tests/fixtures/envelopes/lookup.zip").unwrap();
    let file = JominiFile::from_file(file).unwrap();
    assert_eq!(file.header().kind(), SaveHeaderKind::UnifiedBinary);
    zip_binary_assertions(&file);

    let JominiFileKind::Zip(zip) = file.kind() else {
        panic!("expected zip binary envelope");
    };

    // Make sure that we can access the lookup file specifically
    let mut lookup_file = zip.read_entry("string-lookup").unwrap();
    let mut lookup_data = String::new();
    lookup_file.read_to_string(&mut lookup_data).unwrap();
    assert_eq!(lookup_data, "hello-world");

    let Err(err) = zip.read_entry("nonexistent-file") else {
        panic!("expected missing entry error");
    };
    assert!(err.is_missing_entry());
}

/// Returns the byte offset of the central-directory file header for `name`, so
/// a test can deterministically corrupt its metadata.
fn find_central_directory_header(data: &[u8], name: &[u8]) -> usize {
    let archive = rawzip::ZipArchive::from_slice(data).unwrap();
    let mut entries = archive.entries();
    while let Some(entry) = entries.next_entry().unwrap() {
        if entry.file_path().as_ref() == name {
            return entry.central_directory_offset() as usize;
        }
    }
    panic!("central directory header not found for {:?}", name);
}

#[test]
fn zip_gamestate_verified_matches_plain() {
    let data = std::fs::read("tests/fixtures/envelopes/text.zip").unwrap();
    let file = JominiFile::from_slice(&data).unwrap();
    let JominiFileKind::Zip(zip) = file.kind() else {
        panic!("expected zip text envelope");
    };

    let mut verified = String::new();
    zip.gamestate_verified()
        .unwrap()
        .read_to_string(&mut verified)
        .unwrap();
    assert_eq!(verified, EXPECTED_TEXT_GAMESTATE);

    let mut plain = String::new();
    zip.gamestate().unwrap().read_to_string(&mut plain).unwrap();
    assert_eq!(verified, plain);

    // The finish() path drains the reader, re-verifies, and hands back the
    // inner reader on success.
    let SaveContentKind::Text(content) = zip.gamestate_verified().unwrap() else {
        panic!("expected text gamestate");
    };
    let mut reader = content.into_inner();
    let copied = std::io::copy(&mut reader, &mut std::io::sink()).unwrap();
    assert_eq!(copied as usize, EXPECTED_TEXT_GAMESTATE.len());
    reader.finish().unwrap();
}

#[test]
fn zip_gamestate_verified_detects_bad_crc() {
    let mut data = std::fs::read("tests/fixtures/envelopes/text.zip").unwrap();
    let cd = find_central_directory_header(&data, b"gamestate");
    // Flip the central-directory CRC32 (bytes 16..20) to a guaranteed-wrong value.
    let orig = u32::from_le_bytes(data[cd + 16..cd + 20].try_into().unwrap());
    data[cd + 16..cd + 20].copy_from_slice(&(orig ^ 0xFFFF_FFFF).to_le_bytes());

    let file = JominiFile::from_slice(&data).unwrap();
    let JominiFileKind::Zip(zip) = file.kind() else {
        panic!("expected zip text envelope");
    };

    // Unverified read still succeeds on the same bytes.
    let mut plain = String::new();
    zip.gamestate().unwrap().read_to_string(&mut plain).unwrap();
    assert_eq!(plain, EXPECTED_TEXT_GAMESTATE);

    // finish() surfaces the owned ChecksumMismatch.
    let SaveContentKind::Text(content) = zip.gamestate_verified().unwrap() else {
        panic!("expected text gamestate");
    };
    let err = content.into_inner().finish().unwrap_err();
    assert!(
        matches!(err.kind(), EnvelopeErrorKind::ChecksumMismatch { expected, .. } if *expected == (orig ^ 0xFFFF_FFFF)),
        "unexpected error: {err:?}"
    );

    // The inline Read path also fails (as io::ErrorKind::InvalidData).
    let mut buf = String::new();
    let io_err = zip
        .gamestate_verified()
        .unwrap()
        .read_to_string(&mut buf)
        .unwrap_err();
    assert_eq!(io_err.kind(), std::io::ErrorKind::InvalidData);
}

#[test]
fn zip_read_entry_verified() {
    let data = std::fs::read("tests/fixtures/envelopes/lookup.zip").unwrap();
    let file = JominiFile::from_slice(&data).unwrap();
    let JominiFileKind::Zip(zip) = file.kind() else {
        panic!("expected zip binary envelope");
    };

    let mut lookup = String::new();
    zip.read_entry_verified("string-lookup")
        .unwrap()
        .read_to_string(&mut lookup)
        .unwrap();
    assert_eq!(lookup, "hello-world");

    let err = zip.read_entry_verified("nonexistent-file").unwrap_err();
    assert!(err.is_missing_entry());
}

#[test]
fn zip_gamestate_verified_detects_bad_size() {
    let mut data = std::fs::read("tests/fixtures/envelopes/text.zip").unwrap();
    let cd = find_central_directory_header(&data, b"gamestate");
    // Inflate the central-directory uncompressed size (bytes 24..28) so the
    // expectation exceeds the real decompressed length -> SizeMismatch at EOF.
    let orig = u32::from_le_bytes(data[cd + 24..cd + 28].try_into().unwrap());
    data[cd + 24..cd + 28].copy_from_slice(&(orig + 1000).to_le_bytes());

    let file = JominiFile::from_slice(&data).unwrap();
    let JominiFileKind::Zip(zip) = file.kind() else {
        panic!("expected zip text envelope");
    };
    let SaveContentKind::Text(content) = zip.gamestate_verified().unwrap() else {
        panic!("expected text gamestate");
    };
    let err = content.into_inner().finish().unwrap_err();
    assert!(
        matches!(err.kind(), EnvelopeErrorKind::SizeMismatch { expected, actual } if *expected == u64::from(orig) + 1000 && *actual == u64::from(orig)),
        "unexpected error: {err:?}"
    );
}

struct TestFlavor;

impl Encoding for TestFlavor {
    fn decode<'a>(&self, data: &'a [u8]) -> std::borrow::Cow<'a, str> {
        Utf8Encoding::decode(data)
    }
}

impl BinaryFlavor for TestFlavor {
    fn visit_f32(&self, data: [u8; 4]) -> f32 {
        f32::from_le_bytes(data)
    }

    fn visit_f64(&self, data: [u8; 8]) -> f64 {
        f64::from_le_bytes(data)
    }
}

type BinaryDeserializer<'r, 'res, RES> = BinaryReaderDeserializer<'r, 'res, RES, TestFlavor>;

trait DeserializeBinary {
    fn deserializer<'r, 'res, RES: TokenResolver>(
        &'r mut self,
        resolver: &'res RES,
    ) -> BinaryDeserializer<'r, 'res, RES>
    where
        Self: 'r;
}

impl<R: ReaderAt> DeserializeBinary for SaveData<BinaryEncoding, R> {
    fn deserializer<'r, 'res, RES: TokenResolver>(
        &'r mut self,
        resolver: &'res RES,
    ) -> BinaryDeserializer<'r, 'res, RES>
    where
        Self: 'r,
    {
        BinaryDeserializerBuilder::with_flavor(TestFlavor)
            .from_reader(self.body().cursor(), resolver)
    }
}

impl<R: Read> DeserializeBinary for SaveContent<BinaryEncoding, R> {
    fn deserializer<'r, 'res, RES: TokenResolver>(
        &'r mut self,
        resolver: &'res RES,
    ) -> BinaryDeserializer<'r, 'res, RES>
    where
        Self: 'r,
    {
        BinaryDeserializerBuilder::with_flavor(TestFlavor).from_reader(self, resolver)
    }
}

impl<R: Read> DeserializeBinary for SaveMetadata<BinaryEncoding, R> {
    fn deserializer<'r, 'res, RES: TokenResolver>(
        &'r mut self,
        resolver: &'res RES,
    ) -> BinaryDeserializer<'r, 'res, RES>
    where
        Self: 'r,
    {
        BinaryDeserializerBuilder::with_flavor(TestFlavor).from_reader(self, resolver)
    }
}

#[test]
fn body_consistency_between_file_and_slice() {
    test_body_consistency("tests/fixtures/envelopes/text.txt");
    test_body_consistency("tests/fixtures/envelopes/autosave.bin");
    test_body_consistency("tests/fixtures/envelopes/sav02.txt");
}

fn test_body_consistency(file_path: &str) {
    let data = std::fs::read(file_path).unwrap();
    let file_from_slice = JominiFile::from_slice(&data).unwrap();
    let file_from_file = JominiFile::from_file(std::fs::File::open(file_path).unwrap()).unwrap();

    let mut buf_from_slice = Vec::new();
    match file_from_slice.kind() {
        JominiFileKind::Uncompressed(SaveDataKind::Text(data)) => {
            data.body()
                .cursor()
                .read_to_end(&mut buf_from_slice)
                .unwrap();
        }
        JominiFileKind::Uncompressed(SaveDataKind::Binary(data)) => {
            data.body()
                .cursor()
                .read_to_end(&mut buf_from_slice)
                .unwrap();
        }
        JominiFileKind::Zip(_) => panic!("expected uncompressed data from slice"),
    };

    let mut buf_from_file = Vec::new();
    match file_from_file.kind() {
        JominiFileKind::Uncompressed(SaveDataKind::Text(data)) => {
            data.body()
                .cursor()
                .read_to_end(&mut buf_from_file)
                .unwrap();
        }
        JominiFileKind::Uncompressed(SaveDataKind::Binary(data)) => {
            data.body()
                .cursor()
                .read_to_end(&mut buf_from_file)
                .unwrap();
        }
        JominiFileKind::Zip(_) => panic!("expected uncompressed data from file"),
    };

    assert_eq!(
        buf_from_slice, buf_from_file,
        "Body content should match between from_slice and from_file"
    );

    assert!(
        !buf_from_slice.starts_with(b"SAV"),
        "Body should not include header"
    );
}

#[test]
fn body_slice_via_offset_excludes_header() {
    // Test that one can access the body slice using `JominiFile::from_slice`
    let data = std::fs::read("tests/fixtures/envelopes/text.txt").unwrap();
    let file = JominiFile::from_slice(&data).unwrap();

    let JominiFileKind::Uncompressed(SaveDataKind::Text(save_data)) = file.kind() else {
        panic!("expected text uncompressed");
    };

    let body = save_data.body();
    let source = body.get_ref().get_ref().as_slice();
    let body_slice = &source[body.content_offset() as usize..];

    let mut body_from_cursor = Vec::new();
    body.cursor().read_to_end(&mut body_from_cursor).unwrap();

    assert_eq!(body_slice, body_from_cursor.as_slice());
    assert!(
        !body_slice.starts_with(b"SAV"),
        "Body slice should not include header, but got: {:?}",
        std::str::from_utf8(&body_slice[..3.min(body_slice.len())])
    );
}