ObjectStoreX.Range (ObjectStoreX v0.2.0)

View Source

Represents a byte range for partial object reads.

A range specifies a contiguous sequence of bytes to fetch from an object, with start being inclusive and end being exclusive (Rust-style range).

Fields

  • :start - Start byte position (inclusive, 0-indexed)
  • :end - End byte position (exclusive)

Examples

# Fetch first 1KB (bytes 0-999)
%ObjectStoreX.Range{start: 0, end: 1000}

# Fetch bytes 100-199
%ObjectStoreX.Range{start: 100, end: 200}

# Fetch 1MB starting at 1MB offset
%ObjectStoreX.Range{start: 1_048_576, end: 2_097_152}

Notes

The range follows Rust-style half-open intervals [start, end):

  • start is inclusive
  • end is exclusive
  • The number of bytes fetched is end - start

Summary

Types

t()

Functions

new(start, end_pos)

Create a new Range struct.

size(range)

Calculate the size (number of bytes) in the range.

Types

t()

@type t() :: %ObjectStoreX.Range{end: non_neg_integer(), start: non_neg_integer()}

Functions

new(start, end_pos)

@spec new(non_neg_integer(), non_neg_integer()) :: t()

Create a new Range struct.

Examples

iex> ObjectStoreX.Range.new(0, 1000)
%ObjectStoreX.Range{start: 0, end: 1000}

size(range)

@spec size(t()) :: non_neg_integer()

Calculate the size (number of bytes) in the range.

Examples

iex> range = ObjectStoreX.Range.new(0, 1000)
iex> ObjectStoreX.Range.size(range)
1000

iex> range = ObjectStoreX.Range.new(100, 200)
iex> ObjectStoreX.Range.size(range)
100