Tay.Storage.Segment (tay v0.7.0)

Physical v1 segment container. See the Phase 2 segment RFC for the byte contract.

Checksums, framing, and sequence continuity establish physical integrity only. No result authorizes repair, semantic replay, or an applied checkpoint.

Summary

Functions

decode_footer(bytes, expected \\ %{})

decode_header(bytes, expected \\ %{})

decode_store(bytes)

encode_footer(footer)

encode_header(arg1)

encode_store(store_id)

filename(id)

filename_id(name)

max_bytes()

max_count()

max_id()

min_rotation_bytes()

parse(bytes, options \\ [])

Validates a complete in-memory segment without retaining its records.

reduce(read, size, accumulator, reducer, options \\ [])

Physical reduction; accumulator is returned only on complete success.

reduce_while(read, size, accumulator, visitor, options \\ [])

Halt-aware physical traversal; errors never return a successful prefix accumulator.

scan(read, size, options \\ [])

Validates a segment through bounded positional reads. No writes occur.

Functions

decode_footer(bytes, expected \\ %{})

decode_header(bytes, expected \\ %{})

decode_store(bytes)

@spec decode_store(any()) ::
  false
  | <<_::64, _::_*8>>
  | {:error,
     :checksum
     | :invalid_argument
     | :invalid_magic
     | :invalid_store_id
     | :reserved_bytes
     | :trailing_store_bytes
     | {:invalid_version, 0}
     | {:unsupported_flags, byte()}
     | {:unsupported_version, byte()}}
  | {:incomplete, 28 | 44 | 64}
  | {:ok, <<_::128>>}

encode_footer(footer)

@spec encode_footer(any()) ::
  false
  | {:error,
     :count_sequence_relation
     | :invalid_argument
     | :invalid_crc
     | :invalid_first_sequence
     | :invalid_last_sequence
     | :invalid_record_count
     | :invalid_segment_id
     | :invalid_store_id}
  | {:ok, <<_::32, _::_*8>>}

encode_header(arg1)

@spec encode_header(any()) ::
  {:error,
   :invalid_argument
   | :invalid_first_sequence
   | :invalid_segment_id
   | :invalid_store_id}
  | {:ok, <<_::32, _::_*8>>}

encode_store(store_id)

@spec encode_store(any()) :: {:error, :invalid_store_id} | {:ok, <<_::32, _::_*8>>}

filename(id)

@spec filename(any()) :: {:error, :invalid_segment_id} | {:ok, <<_::32, _::_*8>>}

filename_id(name)

@spec filename_id(any()) ::
  {:error, :invalid_segment_id | :invalid_segment_name} | {:ok, integer()}

max_bytes()

@spec max_bytes() :: 1_073_741_824

max_count()

@spec max_count() :: 38_347_918

max_id()

@spec max_id() :: 18_446_744_073_709_551_615

min_rotation_bytes()

@spec min_rotation_bytes() :: 16_777_352

parse(bytes, options \\ [])

Validates a complete in-memory segment without retaining its records.

reduce(read, size, accumulator, reducer, options \\ [])

Physical reduction; accumulator is returned only on complete success.

reduce_while(read, size, accumulator, visitor, options \\ [])

Halt-aware physical traversal; errors never return a successful prefix accumulator.

scan(read, size, options \\ [])

Validates a segment through bounded positional reads. No writes occur.