Crate txtar

Expand description

txtar is a rust implementation of the txtar Go package.

About

txtars purpose is best described in the original Go package:

Package txtar implements a trivial text-based file archive format.

The goals for the format are:

be trivial enough to create and edit by hand.

be able to store trees of text files describing go command test cases.

diff nicely in git history and code reviews.

Non-goals include being a completely general archive format, storing binary data, storing file modes, storing special files like symbolic links, and so on.

format spec

The format spec as written in the txtar Go package source code:

Txtar format

A txtar archive is zero or more comment lines and then a sequence of file entries. Each file entry begins with a file marker line of the form “-- FILENAME --” and is followed by zero or more file content lines making up the file data. The comment or file content ends at the next file marker line. The file marker line must begin with the three-byte sequence “-- ” and end with the three-byte sequence “ --”, but the enclosed file name can be surrounding by additional white space, all of which is stripped.

If the txtar file is missing a trailing newline on the final line, parsers should consider a final newline to be present anyway.

There are no possible syntax errors in a txtar archive.

Example

let txt = "\
comment1
comment2
-- file1 --
File 1 text.
-- foo/bar --
File 2 text.
-- empty --
-- noNL --
hello world";

let archive = txtar::from_str(txt);
archive.materialize("/tmp/somedir/").unwrap();

Structs

Enums

MaterializeError

Functions

from_bytes

Try to read an archive from bytes of txtar data.

from_str

Read an archive from a string of txtar data.