Module peppi::frame

Frame data representation.

Peppi represents frame data using Arrow arrays (i.e. “struct-of-arrays”). This allows us to efficiently share frame data with other languages, and enables simple serialization into a highly-compressible disk format.

The mutable/immutable distinction is essentially an artifact of the underlying Arrow library. You’ll only encounter mutable frame data if you’re parsing live games.

Modules

• immutable
  Immutable (fully-parsed) frame data, as Arrow arrays.
• mutable
  Mutable (in-progress) frame data.
• transpose
  Single-frame representation using normal structs.

Structs

• PortOccupancy
  Port number plus ICs-specific discriminant.

Enums

• Rollbacks
  Rollback-aware processing typically ignores all but the first or last rollback for a frame.

Constants

• FIRST_INDEX
  Frame indexes start at -123, and reach 0 at “Go!”.