Hrx.Archive (hrx v0.1.0) View Source

HRX file archive

Contains the contents in memory of an HRX file.

Link to this section Summary

Link to this section Types

Specs

t() :: %Hrx.Archive{entries: %{required(String.t()) => Hrx.Entry.t()}}

Link to this section Functions

Specs

read(t(), String.t()) :: {:ok, String.t()} | {:error, :enoent}

Read a file from the archive

{:ok, contents} = Hrx.Archive.read(archive, "dir/my-file.txt")
{:error, :enoent} = Hrx.Archive.read(archive, "non-existant-file.txt")