ansi-color-codec 3.0.0

Encode bytes as ANSI background colors
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

# ansi-color-codec


Encode arbitrary byte sequences with ANSI background colors.

[showcase.webm](https://user-images.githubusercontent.com/3766192/201553147-a4a18950-e346-4d61-833a-804b72f98fd6.webm)

## Usage


You can use the program as a library or as a command line utility.

### Library


The library provides a trait `ColorCodec<T>` that allows arbitrary byte
iterators
(`Iterator<Item = u8>`) to encode their bytes as ANSI background color
codes or decode them back again.
Therefor the trait provides the functions `encode()` and
`decode()`.

The library is `no_std` as does not require `alloc`.

### Command line utility


You can encode bytes or decode color codes by passing them to
`ansi-color-codec`'s STDIN:

```shell
$ echo "I use Arch btw" | ansi-color-codec
$ echo "I use Arch btw" | ansi-color-codec | ansi-color-codec -d
```

For more options, see `ansi-color-codec -h`.