Struct PaxDecodePolicy

Source

pub struct PaxDecodePolicy { /* private fields */ }

Expand description

Controls pax compatibility and the feature subset member decoding may accept.

See each allow API for its default.

Implementations§

Source §

impl PaxDecodePolicy

Source

pub fn max_extension_size(self, max_extension_size: u64) -> Self

Configures the maximum payload size in bytes accepted for one pax extension.

The limit applies independently to each local or global extension and covers all records in that extension. An extension that declares a larger payload is rejected before its payload is consumed.

The default is DEFAULT_MAX_PAX_EXTENSION_SIZE. Setting the limit to zero rejects every nonempty pax extension. Setting it to u64::MAX removes the per-extension bound; global extensions remain subject to their cumulative limit.

Source

pub fn max_global_extensions_size(self, max_global_extensions_size: u64) -> Self

Configures the maximum cumulative payload size of global pax extensions.

The total is reset after each ordinary member. A global extension that would increase the pending total beyond this limit is rejected before its payload is consumed. The default is DEFAULT_MAX_GLOBAL_PAX_EXTENSIONS_SIZE. Setting the limit to zero rejects every nonempty global extension. Setting it to u64::MAX removes the cumulative bound; each extension remains subject to its individual limit.

Source

pub fn allow_non_utf8_pax_vendor_values(self, allow: bool) -> Self

Configures whether vendor-namespaced pax record values may contain non-UTF-8 bytes.

This compatibility option is enabled by default to accommodate raw extensions incorrectly emitted by other real-world writers. Disabling it requires every vendor record value to be valid UTF-8. Vendor values remain exposed as opaque bytes in either mode.

Self::allow_unknown_pax_vendor_records separately controls whether decoding may ignore vendor records after they have been parsed.

Source

pub fn allow_global_pax_extensions(self, allow: bool) -> Self

Configures whether global pax extension headers may be accepted.

When enabled, Self::allow_global_pax_member_metadata separately controls whether global path, linkpath, and size records are accepted. Trailing global headers without a following ordinary member are consumed and ignored before policy checks.

Global pax extension headers are allowed by default.

Source

pub fn allow_unknown_pax_vendor_records(self, allow: bool) -> Self

Configures whether unknown vendor-namespaced pax records may be accepted.

When enabled, well-formed vendor-namespaced pax records do not cause a decoding error. Their values are parsed structurally, but their semantics are not interpreted.

This can produce output that differs from the archive’s intended contents. For example, GNU.sparse.* records can change a member’s effective name, logical size, and mapping from stored payload bytes to file contents; these semantics are ignored when this option is enabled.

IMPORTANT: Only enable this when silently ignoring unknown vendor semantics is acceptable. Unknown vendor-namespaced pax records are forbidden by default.

Source