typist-0.1.0.1: README.md

# Typist

Typist is a library for interpolation. It uses type-level strings (`Symbol`s) for template. It uses `UnconsSynbol` type family which is added in GHC-9.2, so you need GHC version 9.2 or higher to use it.   

Core functionality is in `Typist.Internal.Format`: 
* Type family `Format` which transforms `Symbol` to function which renders final _string_ 
* `Arg` newtype over `Text.Lazy.Builder` which carries name of parameter and it's position in string on type-level (for perfomance goods)
* Type class `Interpolate` which renders final _string_ on term level

An example of wrapping it (and also ready to use interface) is located in `Typist.TextShow`:
* `Unquoted` newtype for interpolation strings without `\"`  
* `#=` set operator
Example (more examples can be found in `test/Test`):

```haskell
question = fmt @"Hello, #{name}, do you like #{dish}?" $ 
  (#name #= Unquoted "Mike") .
  (#dish #= Unquoted "pasta")
```

Performance is comparable with bare concatenation with `<>`. Benches can be found at `test/Bench`
### O2
![Alt text](https://raw.githubusercontent.com/goosedb/typist/059006de73e88111571aad0fc3f841506d96d6ec/results_cpu_o2.svg)
### O1
![Alt text](https://raw.githubusercontent.com/goosedb/typist/059006de73e88111571aad0fc3f841506d96d6ec/results_cpu_o1.svg)
### O0
![Alt text](https://raw.githubusercontent.com/goosedb/typist/059006de73e88111571aad0fc3f841506d96d6ec/results_cpu_o0.svg) 

To run benchmark use
```
$ cabal bench --benchmark-options '--svg results_cpu.svg'
```