Module dumpfile_parse 

Parsing and generating composefs dump file entry

The composefs project defines a “dump file” which is a textual serializion of the metadata file. This module supports parsing and generating dump file entries.

Structs

DumpConfig

Configuration for parsing a dumpfile

Entry

A composefs dumpfile entry

Mtime

Modification time

Xattr

An extended attribute entry

Enums

EscapeMode 🔒

Item

A serializable composefs entry.

Constants

MAX_INLINE_CONTENT 🔒

Maximum size accepted for inline content.

PATH_MAX 🔒

https://github.com/torvalds/linux/blob/47ac09b91befbb6a235ab620c32af719f8208399/include/uapi/linux/limits.h#L13

XATTR_LIST_MAX 🔒

XATTR_NAME_MAX 🔒

https://github.com/torvalds/linux/blob/47ac09b91befbb6a235ab620c32af719f8208399/include/uapi/linux/limits.h#L15 This isn’t exposed in libc/rustix, and in any case we should be conservative…if this ever gets bumped it’d be a hazard.

XATTR_SIZE_MAX 🔒

Functions

dump

Parse the provided composefs into dumpfile entries.

escape 🔒

Escape a byte array according to the composefs dump file text format.

optional_str 🔒

If the provided string is empty, map it to -.

unescape 🔒

Unescape a byte array according to the composefs dump file escaping format.

unescape_limited 🔒

Unescape a byte array according to the composefs dump file escaping format, limiting the maximum possible size.

unescape_to_osstr 🔒

Unescape a string into a Rust OsStr which is really just an alias for a byte array, but we also impose a constraint that it can not have an embedded NUL byte.

unescape_to_path 🔒

Unescape a string into a Rust Path, which is like a byte array but with a few constraints:

unescape_to_path_canonical 🔒

Like unescape_to_path, but also ensures the path is in “canonical” form; this has the same semantics as Rust https://doc.rust-lang.org/std/path/struct.Path.html#method.components which in particular removes . and extra //.

Type Aliases

Xattrs

A full set of extended attributes