Struct PaxBuilder 

pub struct PaxBuilder { /* private fields */ }

Builder for PAX extended header records.

PAX extended headers contain key-value pairs that extend the basic tar header format, allowing for longer paths, larger file sizes, and additional metadata.

Format

Each record has the format: <length> <key>=<value>\n where <length> is the total record length including the length field itself.

Example

use tar_core::builder::PaxBuilder;

let mut builder = PaxBuilder::new();
builder
    .path(b"/very/long/path/that/exceeds/100/characters/limit.txt")
    .size(1_000_000_000_000);
let data = builder.finish();

Implementations

impl PaxBuilder

pub fn new() -> Self

Create a new empty PAX builder.

pub fn add(&mut self, key: &str, value: impl AsRef<[u8]>) -> &mut Self

Add a key-value record.

The record is formatted as <length> <key>=<value>\n.

The length prefix includes itself, which requires computing how many decimal digits the total length will occupy. This uses the same algorithm as tar-rs’s append_pax_extensions.

pub fn path(&mut self, path: impl AsRef<[u8]>) -> &mut Self

Add a path record.

pub fn linkpath(&mut self, path: impl AsRef<[u8]>) -> &mut Self

Add a linkpath record.

pub fn add_u64(&mut self, key: &str, value: u64) -> &mut Self

Add a record with a u64 value formatted as decimal.

pub fn size(&mut self, size: u64) -> &mut Self

Add a size record.

pub fn uid(&mut self, uid: u64) -> &mut Self

Add a uid record.

pub fn gid(&mut self, gid: u64) -> &mut Self

Add a gid record.

pub fn uname(&mut self, name: impl AsRef<[u8]>) -> &mut Self

Add a uname (username) record.

pub fn gname(&mut self, name: impl AsRef<[u8]>) -> &mut Self

Add a gname (group name) record.

pub fn mtime(&mut self, mtime: u64) -> &mut Self

Add an mtime record.

pub fn atime(&mut self, atime: u64) -> &mut Self

Add an atime record.

pub fn ctime(&mut self, ctime: u64) -> &mut Self

Add a ctime record.

pub fn as_bytes(&self) -> &[u8]

Get the current data (for inspection).

pub fn finish(self) -> Vec<u8>

Return the finished PAX extended header data.

Trait Implementations

impl Clone for PaxBuilder

fn clone(&self) -> PaxBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PaxBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PaxBuilder

fn default() -> PaxBuilder

Returns the “default value” for a type.