GorillaStream.File (gorilla_stream v3.0.3)

Copy Markdown View Source

File I/O utilities for GorillaStream compression.

Provides convenient functions to compress data directly to/from files with optional metadata and validation.

Summary

Functions

Compresses data and writes it to a file.

Reads and decompresses data from a file.

Gets information about a compressed file without decompressing.

Validates a compressed file without fully decompressing it.

Functions

compress_to_file(data, filename, opts \\ [])

Compresses data and writes it to a file.

Options

  • :metadata - Additional metadata to store with the compressed data
  • :validate - Whether to validate the data after compression (default: false)

Examples

iex> data = [{1609459200, 23.5}, {1609459201, 23.6}]
iex> GorillaStream.File.compress_to_file(data, "sensor_data.gorilla")
{:ok, %{compressed_size: 123, original_points: 2}}

decompress_from_file(filename)

Reads and decompresses data from a file.

Examples

iex> GorillaStream.File.decompress_from_file("sensor_data.gorilla")
{:ok, data, metadata}

get_file_info(filename)

Gets information about a compressed file without decompressing.

validate_file(filename)

Validates a compressed file without fully decompressing it.