pbfhogg 0.3.0

Fast OpenStreetMap PBF reader and writer for Rust. Read, write, and merge .osm.pbf files with pipelined parallel decoding.
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
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
//! Tests for reading path equivalence: pipeline, par_map_reduce, and seek operations.
//!
//! Verifies that all reading modes produce identical results and that seek
//! operations work correctly on BlobReader.
#![allow(clippy::unwrap_used, clippy::cognitive_complexity, clippy::too_many_lines)]

mod common;

use std::io::SeekFrom;
use std::path::Path;

use pbfhogg::block_builder::{self, BlockBuilder, MemberData};
use pbfhogg::writer::{Compression, PbfWriter};
use pbfhogg::{
    BlobFilter, BlobReader, BlobType, ByteOffset, Element, ElementReader, IndexedReader, MemberId,
};
use tempfile::TempDir;

/// Write a multi-block PBF to the given path.
/// Contains: header + 3 data blocks (3 nodes, 2 ways, 1 relation).
fn write_test_pbf(path: &Path) {
    let file = std::fs::File::create(path).unwrap();
    let mut writer = PbfWriter::new(file, Compression::default());

    let header =
        block_builder::HeaderBuilder::new().bbox(9.0, 54.0, 13.0, 58.0).build()
            .unwrap();
    writer.write_header(&header).unwrap();

    let mut bb = BlockBuilder::new();

    // Block 1: 3 nodes
    bb.add_node(100, 550_000_000, 120_000_000, [("name", "A")], None);
    bb.add_node(200, 560_000_000, 130_000_000, [("name", "B")], None);
    bb.add_node(300, -330_000_000, -580_000_000, std::iter::empty::<(&str, &str)>(), None);
    writer
        .write_primitive_block(bb.take().unwrap().unwrap())
        .unwrap();

    // Block 2: 2 ways
    bb.add_way(1000, [("highway", "primary")], &[100, 200, 300], None);
    bb.add_way(2000, [("building", "yes")], &[200, 300, 200], None);
    writer
        .write_primitive_block(bb.take().unwrap().unwrap())
        .unwrap();

    // Block 3: 1 relation
    bb.add_relation(
        5000,
        [("type", "multipolygon")],
        &[MemberData {
            id: MemberId::Way(1000),
            role: "outer",
        }],
        None,
    );
    writer
        .write_primitive_block(bb.take().unwrap().unwrap())
        .unwrap();

    writer.flush().unwrap();
}

/// Extract (type_char, id) from an element.
fn element_id(element: &Element<'_>) -> (char, i64) {
    match element {
        Element::Node(n) => ('n', n.id()),
        Element::DenseNode(dn) => ('n', dn.id()),
        Element::Way(w) => ('w', w.id()),
        Element::Relation(r) => ('r', r.id()),
        _ => ('?', 0),
    }
}

/// Collect all element IDs using sequential for_each.
fn collect_sequential(path: &Path) -> Vec<(char, i64)> {
    let mut result = Vec::new();
    let reader = ElementReader::from_path(path).unwrap();
    reader
        .for_each(|element| {
            result.push(element_id(&element));
        })
        .unwrap();
    result
}

// ---------------------------------------------------------------------------
// Pipeline tests (via ElementReader::for_each_pipelined)
// ---------------------------------------------------------------------------

/// Pipelined reading produces elements in the same order as sequential reading.
#[test]
fn pipelined_matches_sequential() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let sequential = collect_sequential(&path);

    let mut pipelined = Vec::new();
    let reader = ElementReader::from_path(&path).unwrap();
    reader
        .for_each_pipelined(|element| {
            pipelined.push(element_id(&element));
        })
        .unwrap();

    assert_eq!(sequential, pipelined);
}

/// into_blocks_pipelined yields the same elements as for_each_pipelined.
#[test]
fn block_iterator_matches_pipelined() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let sequential = collect_sequential(&path);

    let mut from_iter = Vec::new();
    let reader = ElementReader::from_path(&path).unwrap();
    for block_result in reader.into_blocks_pipelined() {
        let block = block_result.unwrap();
        for element in block.elements() {
            from_iter.push(element_id(&element));
        }
    }

    assert_eq!(sequential, from_iter);
}

/// into_blocks_pipelined handles early drop without hanging.
#[test]
fn block_iterator_early_drop() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    let mut blocks = reader.into_blocks_pipelined();
    // Take just the first block and drop the iterator
    let _first = blocks.next();
    drop(blocks);
    // If we get here without hanging, the test passes.
}

/// block_type() correctly classifies each block in a sorted PBF.
#[test]
fn block_type_classification() {
    use pbfhogg::BlockType;

    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    let mut types = Vec::new();
    for block_result in reader.into_blocks_pipelined() {
        let block = block_result.unwrap();
        types.push(block.block_type());
    }

    // write_test_pbf creates 3 blocks: dense nodes, ways, relations
    assert_eq!(types, vec![BlockType::DenseNodes, BlockType::Ways, BlockType::Relations]);

    // Convenience methods
    assert!(BlockType::DenseNodes.is_nodes());
    assert!(BlockType::Nodes.is_nodes());
    assert!(!BlockType::Ways.is_nodes());
    assert!(BlockType::Ways.is_ways());
    assert!(BlockType::Relations.is_relations());
    assert!(!BlockType::Mixed.is_nodes());
}

// ---------------------------------------------------------------------------
// par_map_reduce tests
// ---------------------------------------------------------------------------

/// par_map_reduce counts match sequential counts.
#[test]
fn par_map_reduce_count() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let sequential = collect_sequential(&path);
    let expected_nodes = sequential.iter().filter(|(t, _)| *t == 'n').count() as u64;
    let expected_ways = sequential.iter().filter(|(t, _)| *t == 'w').count() as u64;
    let expected_relations = sequential.iter().filter(|(t, _)| *t == 'r').count() as u64;

    let reader = ElementReader::from_path(&path).unwrap();
    let (nodes, ways, relations) = reader
        .par_map_reduce(
            |element| match element {
                Element::Node(_) | Element::DenseNode(_) => (1u64, 0u64, 0u64),
                Element::Way(_) => (0, 1, 0),
                Element::Relation(_) => (0, 0, 1),
                _ => (0, 0, 0),
            },
            || (0, 0, 0),
            |a, b| (a.0 + b.0, a.1 + b.1, a.2 + b.2),
        )
        .unwrap();

    assert_eq!(nodes, expected_nodes);
    assert_eq!(ways, expected_ways);
    assert_eq!(relations, expected_relations);
}

/// par_map_reduce collects the same set of element IDs as sequential (order may differ).
#[test]
fn par_map_reduce_collect_ids() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let mut expected = collect_sequential(&path);
    expected.sort();

    let reader = ElementReader::from_path(&path).unwrap();
    let mut actual: Vec<(char, i64)> = reader
        .par_map_reduce(
            |element| vec![element_id(&element)],
            Vec::new,
            |mut a, b| {
                a.extend(b);
                a
            },
        )
        .unwrap();
    actual.sort();

    assert_eq!(expected, actual);
}

// ---------------------------------------------------------------------------
// BlobReader seek tests
// ---------------------------------------------------------------------------

/// Seeking back to the start re-reads the first blob.
#[test]
fn blobreader_seek_to_start() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let mut reader = BlobReader::seekable_from_path(&path).unwrap();
    let first = reader.next().unwrap().unwrap();
    assert_eq!(first.get_type(), BlobType::OsmHeader);
    assert_eq!(first.offset(), Some(ByteOffset(0)));

    // Seek back to start
    reader.seek(ByteOffset(0)).unwrap();
    let first_again = reader.next().unwrap().unwrap();
    assert_eq!(first_again.get_type(), BlobType::OsmHeader);
    assert_eq!(first_again.offset(), Some(ByteOffset(0)));
}

/// blob_from_offset can random-access any blob by its recorded offset.
#[test]
fn blobreader_blob_from_offset() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    // First pass: collect all blob types (as strings) and offsets
    let mut reader = BlobReader::seekable_from_path(&path).unwrap();
    let mut blobs_info: Vec<(String, ByteOffset)> = Vec::new();
    for blob in reader.by_ref() {
        let blob = blob.unwrap();
        blobs_info.push((
            blob.get_type().as_str().to_string(),
            blob.offset().unwrap(),
        ));
    }

    // Random access each blob by its offset
    for (expected_type, offset) in &blobs_info {
        let blob = reader.blob_from_offset(*offset).unwrap();
        assert_eq!(blob.get_type().as_str(), expected_type.as_str());
        assert_eq!(blob.offset(), Some(*offset));
    }
}

/// seek_raw with SeekFrom::Start(0) restarts; SeekFrom::End(0) reaches EOF.
#[test]
fn blobreader_seek_raw() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let mut reader = BlobReader::seekable_from_path(&path).unwrap();

    // Read first blob
    let _ = reader.next().unwrap().unwrap();

    // Seek back to start
    let pos = reader.seek_raw(SeekFrom::Start(0)).unwrap();
    assert_eq!(pos, 0);
    let blob = reader.next().unwrap().unwrap();
    assert_eq!(blob.get_type(), BlobType::OsmHeader);

    // Seek to end - next should return None (clean EOF)
    let end_pos = reader.seek_raw(SeekFrom::End(0)).unwrap();
    assert!(end_pos > 0);
    assert!(reader.next().is_none());
}

/// seek_raw success clears the sticky error state left by a previous failing
/// `next()`, so callers that recover by seeking past bad bytes can resume.
#[test]
fn blobreader_seek_raw_clears_error_state() {
    // Bytes layout: [oversized blob header length | good PBF].
    //  - The first 4 bytes claim a blob header of ~4 GB, tripping the
    //    MAX_BLOB_HEADER_SIZE guard on the very first `next()` call.
    //  - After the failure, `last_blob_ok = false` makes the reader sticky.
    //  - Seeking past the 4 sentinel bytes should reset the state and let
    //    iteration resume on the good PBF that follows.
    let dir = TempDir::new().unwrap();
    let good_path = dir.path().join("good.osm.pbf");
    write_test_pbf(&good_path);
    let good_bytes = std::fs::read(&good_path).unwrap();

    let mut bytes = vec![0xFFu8, 0xFF, 0xFF, 0xFF]; // claimed header length = 0xFFFFFFFF
    bytes.extend_from_slice(&good_bytes);

    let mut reader = BlobReader::new(std::io::Cursor::new(bytes));

    // First call: HeaderTooBig error; reader becomes sticky.
    assert!(reader.next().unwrap().is_err());
    assert!(reader.next().is_none(), "reader must stay dead until seek");

    // Seek past the sentinel; state must clear.
    reader.seek_raw(SeekFrom::Start(4)).unwrap();

    // Iteration resumes on the good PBF.
    let blob = reader.next().unwrap().unwrap();
    assert_eq!(blob.get_type(), BlobType::OsmHeader);
}

/// next_header_skip_blob scans all headers without decoding blob content.
#[test]
fn blobreader_next_header_skip_blob() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    // Normal iteration: collect types (as strings) and offsets
    let reader = BlobReader::from_path(&path).unwrap();
    let mut expected: Vec<(String, Option<ByteOffset>)> = Vec::new();
    for blob in reader {
        let blob = blob.unwrap();
        expected.push((blob.get_type().as_str().to_string(), blob.offset()));
    }

    // Header-skip iteration: should match types and offsets without decoding
    let mut reader = BlobReader::seekable_from_path(&path).unwrap();
    let mut actual: Vec<(String, Option<ByteOffset>)> = Vec::new();
    while let Some(result) = reader.next_header_skip_blob() {
        let (header, offset) = result.unwrap();
        actual.push((header.blob_type().as_str().to_string(), offset));
    }

    assert_eq!(expected.len(), actual.len());
    for (e, a) in expected.iter().zip(actual.iter()) {
        assert_eq!(e.0, a.0, "blob types must match");
        assert_eq!(e.1, a.1, "offsets must match");
    }
}

// ---------------------------------------------------------------------------
// Header accessor tests
// ---------------------------------------------------------------------------

/// Write a PBF with Sort.Type_then_ID and verify header().is_sorted().
fn write_sorted_pbf(path: &Path) {
    let file = std::fs::File::create(path).unwrap();
    let mut writer = PbfWriter::new(file, Compression::default());

    let header = block_builder::HeaderBuilder::new()
        .bbox(9.0, 54.0, 13.0, 58.0)
        .sorted()
        .build()
        .unwrap();
    writer.write_header(&header).unwrap();

    let mut bb = BlockBuilder::new();
    bb.add_node(1, 550_000_000, 120_000_000, std::iter::empty::<(&str, &str)>(), None);
    bb.add_node(2, 560_000_000, 130_000_000, std::iter::empty::<(&str, &str)>(), None);
    bb.add_node(3, 570_000_000, 140_000_000, std::iter::empty::<(&str, &str)>(), None);
    writer
        .write_primitive_block(bb.take().unwrap().unwrap())
        .unwrap();

    writer.flush().unwrap();
}

/// ElementReader exposes the parsed header via header().
#[test]
fn header_accessor() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_test_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    let header = reader.header();

    // write_test_pbf sets bbox to (9.0, 54.0, 13.0, 58.0)
    let bbox = header.bbox().unwrap();
    assert!((bbox.left - 9.0).abs() < 1e-6);
    assert!((bbox.bottom - 54.0).abs() < 1e-6);

    // writing_program is "pbfhogg"
    assert_eq!(header.writing_program(), Some("pbfhogg"));
}

/// header().is_sorted() returns true when Sort.Type_then_ID is set.
#[test]
fn header_is_sorted_true() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("sorted.osm.pbf");
    write_sorted_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    assert!(reader.header().is_sorted());
}

/// header().is_sorted() returns false when Sort.Type_then_ID is absent.
#[test]
fn header_is_sorted_false() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("unsorted.osm.pbf");
    write_test_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    assert!(!reader.header().is_sorted());
}

/// Elements are still delivered correctly after header is consumed at construction.
#[test]
fn header_consumed_elements_still_work() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("test.osm.pbf");
    write_sorted_pbf(&path);

    let reader = ElementReader::from_path(&path).unwrap();
    assert!(reader.header().is_sorted());

    let mut count = 0u64;
    reader
        .for_each(|_element| {
            count += 1;
        })
        .unwrap();

    assert_eq!(count, 3); // 3 nodes from write_sorted_pbf
}

/// Sorted PBF iterates without assertion failure (nodes in ascending ID order).
#[test]
fn sorted_pbf_no_assertion_failure() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("sorted.osm.pbf");
    write_sorted_pbf(&path);

    // for_each path
    let reader = ElementReader::from_path(&path).unwrap();
    reader.for_each(|_| {}).unwrap();

    // for_each_pipelined path
    let reader = ElementReader::from_path(&path).unwrap();
    reader.for_each_pipelined(|_| {}).unwrap();
}

/// Debug assertion fires on unsorted nodes when Sort.Type_then_ID is declared.
///
/// Requires `debug_assertions` to be enabled in the test profile.
/// Nightly 1.95 (2026-02-25) has a regression where `debug_assertions` is
/// off in test builds, so the test compiles to nothing in our environment.
/// `cfg(debug_assertions)` is the correct gate: the test is only
/// meaningful when the runtime assertion can fire, and `include_ignored`
/// can't resurrect a compile-excluded item (which `#[ignore]` alone left
/// vulnerable - tier 3 / `--profile full` in brokkr.toml runs ignored
/// tests and hit the unfireable-panic case).
#[cfg(debug_assertions)]
#[test]
#[should_panic(expected = "Sort.Type_then_ID violated")]
fn sorted_flag_but_unsorted_nodes_panics() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("liar.osm.pbf");

    // Write a PBF that declares Sort.Type_then_ID but has nodes out of order
    let file = std::fs::File::create(&path).unwrap();
    let mut writer = PbfWriter::new(file, Compression::default());

    let header = block_builder::HeaderBuilder::new()
        .sorted()
        .build()
        .unwrap();
    writer.write_header(&header).unwrap();

    let mut bb = BlockBuilder::new();
    bb.add_node(100, 550_000_000, 120_000_000, std::iter::empty::<(&str, &str)>(), None);
    bb.add_node(50, 560_000_000, 130_000_000, std::iter::empty::<(&str, &str)>(), None); // out of order!
    writer
        .write_primitive_block(bb.take().unwrap().unwrap())
        .unwrap();

    writer.flush().unwrap();

    let reader = ElementReader::from_path(&path).unwrap();
    reader.for_each(|_| {}).unwrap();
}

// ---------------------------------------------------------------------------
// BlobFilter conservative pass-through on non-indexed PBFs
// ---------------------------------------------------------------------------
//
// `should_skip_blob` in `src/read/pipeline.rs:20-33` short-circuits to
// `false` (do not skip) when `blob.index()` is `None`. The doc comment
// calls this out: "Blobs without indexdata or tagdata always pass
// through (conservative)." The consequence is that a filter like
// `BlobFilter::only_ways()` skips node blobs on an indexed PBF but
// does NOT on a non-indexed one - every blob is decompressed and every
// element is delivered to the caller's closure.
//
// The element-level delivery path does not apply any element-type
// filter downstream of the pipeline, so on non-indexed input an
// only_ways filter will silently hand the caller every element type.
// That's the contract these tests pin.

#[test]
fn blobfilter_only_ways_skips_node_blobs_on_indexed_input() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("indexed.osm.pbf");
    common::write_test_pbf_sorted(
        &path,
        &common::generate_nodes(10, 1),
        &common::generate_ways(5, 1_000, 2, 1),
        &[],
    );
    common::assert_indexed(&path);

    let reader = ElementReader::from_path(&path)
        .unwrap()
        .with_blob_filter(BlobFilter::only_ways());

    let mut saw_nodes = 0u64;
    let mut saw_ways = 0u64;
    reader
        .for_each_pipelined(|element| match element {
            Element::Node(_) | Element::DenseNode(_) => saw_nodes += 1,
            Element::Way(_) => saw_ways += 1,
            _ => {}
        })
        .unwrap();

    assert_eq!(saw_nodes, 0, "only_ways filter must skip node blobs on indexed input");
    assert_eq!(saw_ways, 5, "only_ways filter must deliver all ways on indexed input");
}

#[test]
fn blobfilter_only_ways_passes_through_on_non_indexed_input() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("non_indexed.osm.pbf");
    common::write_test_pbf_non_indexed(
        &path,
        &common::generate_nodes(10, 1),
        &common::generate_ways(5, 1_000, 2, 1),
        &[],
    );
    common::assert_non_indexed(&path);

    let reader = ElementReader::from_path(&path)
        .unwrap()
        .with_blob_filter(BlobFilter::only_ways());

    let mut saw_nodes = 0u64;
    let mut saw_ways = 0u64;
    reader
        .for_each_pipelined(|element| match element {
            Element::Node(_) | Element::DenseNode(_) => saw_nodes += 1,
            Element::Way(_) => saw_ways += 1,
            _ => {}
        })
        .unwrap();

    // Node blobs are NOT skipped because the filter's blob-level
    // decision requires indexdata. All 10 nodes reach the closure.
    assert_eq!(
        saw_nodes, 10,
        "BlobFilter on non-indexed input must NOT drop node blobs - callers get every element"
    );
    assert_eq!(saw_ways, 5, "ways still delivered");
}

// ---------------------------------------------------------------------------
// IndexedReader on non-indexed input
// ---------------------------------------------------------------------------
//
// `IndexedReader::create_index` walks only blob headers (not bodies),
// so it does not itself depend on `BlobHeader.indexdata`. The per-blob
// `id_ranges` used by `ways_available` / `node_range_included` are
// populated lazily from decoded blocks via `update_element_id_ranges`
// (src/read/indexed.rs:184) - the same code path runs whether or not
// the input carries indexdata. This test pins that contract: the
// output of `read_ways_and_deps` on a non-indexed PBF must match the
// output on its indexed twin.

#[test]
fn indexed_reader_output_matches_on_indexed_and_non_indexed_twins() {
    let dir = TempDir::new().unwrap();
    let indexed = dir.path().join("indexed.osm.pbf");
    let non_indexed = dir.path().join("non_indexed.osm.pbf");

    // 8 nodes + 4 ways; each way refs two consecutive nodes. "building"
    // tag on odd-numbered ways so read_ways_and_deps has a meaningful
    // filter and node-dependency resolution.
    let nodes = common::generate_nodes(8, 1);
    let mut ways = common::generate_ways(4, 1_000, 2, 1);
    for (i, w) in ways.iter_mut().enumerate() {
        if i % 2 == 0 {
            w.tags = vec![("building", "yes")];
        }
    }

    common::write_test_pbf_sorted(&indexed, &nodes, &ways, &[]);
    common::write_test_pbf_non_indexed(&non_indexed, &nodes, &ways, &[]);
    common::assert_indexed(&indexed);
    common::assert_non_indexed(&non_indexed);

    let collect = |path: &Path| -> (Vec<i64>, Vec<i64>) {
        let mut reader = IndexedReader::from_path(path).unwrap();
        let mut way_ids = Vec::new();
        let mut node_ids = Vec::new();
        reader
            .read_ways_and_deps(
                |w| w.tags().any(|(k, v)| k == "building" && v == "yes"),
                |element| match element {
                    Element::Way(w) => way_ids.push(w.id()),
                    Element::Node(n) => node_ids.push(n.id()),
                    Element::DenseNode(n) => node_ids.push(n.id()),
                    _ => {}
                },
            )
            .unwrap();
        way_ids.sort_unstable();
        node_ids.sort_unstable();
        (way_ids, node_ids)
    };

    let (ways_idx, nodes_idx) = collect(&indexed);
    let (ways_non, nodes_non) = collect(&non_indexed);

    assert_eq!(ways_idx, ways_non, "way set diverges on non-indexed input");
    assert_eq!(nodes_idx, nodes_non, "node dep set diverges on non-indexed input");
    assert!(!ways_idx.is_empty(), "filter must match at least one way");
}

// ---------------------------------------------------------------------------
// Reader-level tolerance contract (`reference/truncation-handling.md`):
// 0-3 leftover bytes of an incomplete next-frame length prefix after a
// complete previous frame is shape 1 - the reader returns `Ok(None)`,
// equivalent to a clean cut at the frame boundary. The `cli_truncation_sweep`
// integration test only pins no-panic at the command level for shape 1
// because some commands (sort) may legitimately reject a partial-input
// file even when the reader's tolerance contract holds. These unit tests
// pin the reader contract directly.
// ---------------------------------------------------------------------------

#[test]
fn trailing_partial_length_prefix_returns_ok_none() {
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("good.osm.pbf");
    write_test_pbf(&path);
    let good_bytes = std::fs::read(&path).unwrap();

    // For each tail byte count in 0..=3, append that many garbage
    // bytes to the complete file and expect the reader to iterate
    // every original blob then return Ok(None). 0 bytes (the
    // unmodified file) establishes the baseline; 1-3 bytes pin the
    // documented tolerance.
    for tail in 0..=3 {
        let mut bytes = good_bytes.clone();
        bytes.extend(std::iter::repeat_n(0xAAu8, tail));

        let mut reader = BlobReader::new(std::io::Cursor::new(bytes));
        let mut blob_count = 0;
        loop {
            match reader.next() {
                Some(Ok(_)) => blob_count += 1,
                Some(Err(e)) => panic!(
                    "reader must tolerate {tail} trailing bytes per the \
                     truncation reference doc; got Err: {e:?}"
                ),
                None => break,
            }
        }
        assert!(
            blob_count >= 1,
            "fixture must contain at least one blob (got {blob_count})"
        );
    }
}

#[test]
fn trailing_partial_length_prefix_4_bytes_is_committed_frame() {
    // 4 bytes is exactly a complete length prefix; that's NOT shape 1
    // anymore - the reader is committed to a frame and must hard-error
    // because the declared header bytes don't follow.
    let dir = TempDir::new().unwrap();
    let path = dir.path().join("good.osm.pbf");
    write_test_pbf(&path);
    let good_bytes = std::fs::read(&path).unwrap();

    let mut bytes = good_bytes.clone();
    bytes.extend_from_slice(&[0x00, 0x00, 0x00, 0x10]); // claims 16-byte header

    let mut reader = BlobReader::new(std::io::Cursor::new(bytes));
    let mut errored = false;
    loop {
        match reader.next() {
            Some(Ok(_)) => {}
            Some(Err(_)) => {
                errored = true;
                break;
            }
            None => break,
        }
    }
    assert!(
        errored,
        "4 trailing bytes (a complete length prefix declaring N>0 \
         header bytes that don't follow) is shape 2, must hard-error"
    );
}