txtarfs

Documentation

Index

• func FS(ar *txtar.Archive) fs.FS
• func From(fsys fs.FS) (*txtar.Archive, error)

Functions

func FS

func FS(ar *txtar.Archive) fs.FS

TxtarFS returns an fs.FS which reads from a txtar.Archive.

func From

func From(fsys fs.FS) (*txtar.Archive, error)

From constructs an Archive with the contents of fsys and an empty Comment. Subsequent changes to fsys are not reflected in the returned archive.

The transformation is lossy. For example, because directories are implicit in txtar archives, empty directories in fsys will be lost, and txtar does not represent file mode, mtime, or other file metadata. From does not guarantee that a.File[i].Data contains no file marker lines. See also warnings on Format. In short, it is unwise to use txtar as a generic filesystem serialization mechanism.