# F3 v0.1.0 - API Reference

## Modules

- [F3](F3.md): Experimental Elixir API for the F3 columnar file format.
- [F3.Batch](F3.Batch.md): Columnar batch.
- [F3.Checksum](F3.Checksum.md): XXH64 checksums for chunk bytes.
- [F3.Column](F3.Column.md): One columnar vector owned by Elixir.
- [F3.Decoder](F3.Decoder.md): Decodes one CASCADE encoding unit into an owned `F3.Column`.
- [F3.Decoder.Native](F3.Decoder.Native.md): Calls the dirty-CPU NIF for one encoding unit.
- [F3.Dispatch](F3.Dispatch.md): Chooses a decoder for one encoding unit.
- [F3.Error](F3.Error.md): Error returned by the public F3 API.
- [F3.Extension](F3.Extension.md): Elixir decoder registered for one footer encoding.
- [F3.File](F3.File.md): Open file handle.
- [F3.FlatBuffer](F3.FlatBuffer.md): Bounded reader for the FlatBuffers tables this library needs.
- [F3.Footer](F3.Footer.md): Decodes an F3 footer into `F3.Metadata`.
- [F3.Format](F3.Format.md): Pinned wire-format constants from upstream F3.
- [F3.IO.FileSystem](F3.IO.FileSystem.md): Operating-system calls used by `F3.IO.Local`.
- [F3.IO.FileSystem.OS](F3.IO.FileSystem.OS.md): `F3.IO.FileSystem` implementation that calls `File` and `:file`.
- [F3.IO.HTTP](F3.IO.HTTP.md): HTTP byte source.
- [F3.IO.Local](F3.IO.Local.md): Local filesystem source.
- [F3.IO.Memory](F3.IO.Memory.md): In-memory byte source.
- [F3.IO.Source](F3.IO.Source.md): Positioned byte source.
- [F3.Inspection](F3.Inspection.md): Text and JSON rendering of `F3.Metadata`.
- [F3.Logical](F3.Logical.md): Stitches physical columns into logical fields.
- [F3.Metadata](F3.Metadata.md): File metadata from the postscript, the FlatBuffers footer, and the
out-of-band column metadata those tables point at.
- [F3.Native](F3.Native.md): Optional native decoder.
- [F3.Postscript](F3.Postscript.md): The 32-byte tail of an F3 file.
- [F3.Reader](F3.Reader.md): Projection, row-group selection, and batching.
- [F3.Registry](F3.Registry.md): Bounded ETS table of `F3.Extension` modules.
- [F3.RowGroup](F3.RowGroup.md): One row group, with the column chunks the footer points at.
- [F3.Schema](F3.Schema.md): Logical Arrow schema read from an F3 footer.
- [F3.Wasm](F3.Wasm.md): Loads one embedded Wasm module after the caller has opted in.
- [F3.Writer](F3.Writer.md): Local F3 writer.

## Mix Tasks

- [mix f3.inspect](Mix.Tasks.F3.Inspect.md): Prints metadata for one F3 file.