Bedrock.DataPlane.Materializer.Olivine.CompactionWriter behaviour (bedrock v0.6.0)

View Source

Behaviour for compaction output writers.

Allows compaction to output to different formats:

  • SplitFile: Two separate files (data + index) for local use
  • Bundle: Single file with data followed by index, for ObjectStorage upload

Summary

Types

result()
t()

Callbacks

finish(t)

Finish writing and return the result. Implementations should sync files to disk before returning.

write_data(t, iodata)

Write data bytes to the compacted output.

write_index(t, iodata)

Write index bytes to the compacted output.

Functions

finish(module, writer)

Dispatch finish to the implementation module.

write_data(module, writer, iodata)

Dispatch write_data to the implementation module.

write_index(module, writer, iodata)

Dispatch write_index to the implementation module.

Types

result()

@type result() :: term()

t()

@type t() :: term()

Callbacks

finish(t)

@callback finish(t()) :: {:ok, result()} | {:error, term()}

Finish writing and return the result. Implementations should sync files to disk before returning.

write_data(t, iodata)

@callback write_data(t(), iodata()) :: {:ok, t()} | {:error, term()}

Write data bytes to the compacted output.

write_index(t, iodata)

@callback write_index(t(), iodata()) :: {:ok, t()} | {:error, term()}

Write index bytes to the compacted output.

Functions

finish(module, writer)

@spec finish(module(), t()) :: {:ok, result()} | {:error, term()}

Dispatch finish to the implementation module.

write_data(module, writer, iodata)

@spec write_data(module(), t(), iodata()) :: {:ok, t()} | {:error, term()}

Dispatch write_data to the implementation module.

write_index(module, writer, iodata)

@spec write_index(module(), t(), iodata()) :: {:ok, t()} | {:error, term()}

Dispatch write_index to the implementation module.