packkit/recipe

Types

Recipe

opaque </>

Opaque archive+codec composition. Every public Recipe carries an archive layer; the raw byte-to-byte path is served by the codec-only packkit.compress / packkit.decompress entrypoints rather than by a “headless” recipe variant, so values constructed here cannot represent unusable states.

reversed_codecs stores codecs in outer-to-inner order so [wrap] runs in O(1); accessors reverse on read.

pub opaque type Recipe

Values

ar

</>

pub fn ar() -> Recipe

Convenience constructor for a bare ar archive (BSD long-name format on encode; GNU string-table form also accepted on decode).

archive_format

</>

pub fn archive_format(recipe: Recipe) -> archive.ArchiveFormat

Read the archive format the recipe was constructed with.

archive_only

</>

pub fn archive_only(
  format format: archive.ArchiveFormat,
) -> Recipe

Create a recipe that carries an archive but no outer codec yet.

archive_with

</>

pub fn archive_with(
  format format: archive.ArchiveFormat,
  wrapped_by wrapped_by: codec.Codec,
) -> Recipe

Create a recipe with an archive and one outer codec.

codecs

</>

pub fn codecs(recipe: Recipe) -> List(codec.Codec)

Read the codec chain in inner-to-outer order.

cpio

</>

pub fn cpio() -> Recipe

Convenience constructor for a bare cpio (newc) archive.

cpio_bzip2

</>

pub fn cpio_bzip2() -> Recipe

cpio.bz2 recipe — cpio body, bzip2-compressed envelope.

cpio_gzip

</>

pub fn cpio_gzip() -> Recipe

Convenience constructor for cpio.gz.

cpio_xz

</>

pub fn cpio_xz() -> Recipe

cpio.xz recipe — cpio body, xz-compressed envelope.

cpio_zstd

</>

pub fn cpio_zstd() -> Recipe

cpio.zst recipe — cpio body, zstd-compressed envelope.

description

</>

pub fn description(recipe: Recipe) -> String

Human-readable canonical description for debugging and tests.

outermost_codec

</>

pub fn outermost_codec(
  recipe: Recipe,
) -> option.Option(codec.Codec)

Read the outermost codec, if any.

seven_z

</>

pub fn seven_z() -> Recipe

Convenience constructor for a bare 7z archive. Like ZIP, 7z applies its own internal compression and does not take a recipe codec wrapper; this constructor keeps the API symmetric across archive families.

tar

</>

pub fn tar() -> Recipe

Convenience constructor for a bare tar archive (no outer codec). Equivalent to archive_only(format: archive.tar()); provided so the same packkit.pack / packkit.unpack entrypoints serve both uncompressed tar and codec-wrapped tar without the caller switching to packkit.write / packkit.read.

tar_brotli

</>

pub fn tar_brotli() -> Recipe

Convenience constructor for tar.br. Round-trips end-to-end via brotli’s uncompressed-metablock encoder; the bytes are valid for any conforming brotli decoder but do no actual LZ77/Huffman compression yet.

tar_bzip2

</>

pub fn tar_bzip2() -> Recipe

Convenience constructor for tar.bz2.

tar_gzip

</>

pub fn tar_gzip() -> Recipe

Convenience constructor for tar.gz.

tar_lz4

</>

pub fn tar_lz4() -> Recipe

Convenience constructor for tar.lz4.

tar_lzw

</>

pub fn tar_lzw() -> Recipe

Convenience constructor for tar.Z (Unix compress / LZW).

tar_snappy

</>

pub fn tar_snappy() -> Recipe

Convenience constructor for tar.snappy.

tar_xz

</>

pub fn tar_xz() -> Recipe

Convenience constructor for tar.xz.

tar_zlib

</>

pub fn tar_zlib() -> Recipe

Convenience constructor for tar.zlib.

tar_zstd

</>

pub fn tar_zstd() -> Recipe

Convenience constructor for tar.zst.

wrap

</>

pub fn wrap(
  recipe: Recipe,
  with outer_codec: codec.Codec,
) -> Recipe

Wrap an existing recipe in one more outer codec. O(1) thanks to the reversed internal codec list.

zip

</>

pub fn zip() -> Recipe

Convenience constructor for a bare ZIP archive. ZIP carries its own per-entry compression internally, so there’s no recipe-level codec to wrap it in — but exposing recipe.zip() lets callers use the same packkit.pack / packkit.unpack API they use for tar recipes, instead of switching to packkit.write / packkit.read.