Skip to content

Commit 030061d

Browse files
dfa1claude
andcommitted
docs(reader): cite the Rust SerializedArray counterpart
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 3a657a3 commit 030061d

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

reader/src/main/java/io/github/dfa1/vortex/reader/SerializedArrayDecoder.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,15 @@
1515
import java.lang.foreign.SegmentAllocator;
1616
import java.util.List;
1717

18-
/// Parses a flat segment from the memory-mapped file region and dispatches to the
19-
/// appropriate decoder via the [ReadRegistry].
18+
/// Decodes one serialized array message — the wire unit a flat layout's segment stores — by
19+
/// parsing its FlatBuffer scaffolding and dispatching to the appropriate decoder via the
20+
/// [ReadRegistry].
2021
///
21-
/// Flat segment wire format:
22+
/// Named after the Rust reference's `SerializedArray` (`vortex-array/src/serde.rs`): "a parsed
23+
/// but not-yet-decoded deserialized array" whose `decode` resolves the encoding id against the
24+
/// spec table and consults the registry — exactly this class's contract.
25+
///
26+
/// Serialized array wire format:
2227
/// `buffer_data... | FlatBuffer(Array) | u32 LE = FlatBuffer byte length`
2328
///
2429
/// [ReadRegistry] is pure dispatch; this class owns all file-format knowledge:

0 commit comments

Comments
 (0)