txtar 1.0.0

A Rust implementation of the txtar Go package
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# txtar

[![crates.io version][1]][2]
[![docs.rs docs][3]][4]
[![license][5]][6]

A Rust implementation of the [txtar](https://github.com/golang/tools/tree/master/txtar) Go package.

```sh
cargo add txtar
```

## Usage
```rust no_run
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();
```

## Txtar goals
As described in the 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.


## Txtar 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.

## License

[MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE)


[1]: https://img.shields.io/crates/v/txtar.svg?style=flat-square
[2]: https://crates.io/crates/txtar
[3]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square
[4]: https://docs.rs/txtar
[5]: https://img.shields.io/crates/l/txtar.svg?style=flat-square
[6]: #license