diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Revision history for safe-interpolate -## 0.1.0.0 -- YYYY-mm-dd +## 0.1.0.0 -- 2024-04-30 * First version. Released on an unsuspecting world. + +## 0.1.0.1 -- 2024-04-30 + +* Added readme diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# 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' +``` diff --git a/results_cpu_o0.svg b/results_cpu_o0.svg new file mode 100644 --- /dev/null +++ b/results_cpu_o0.svg @@ -0,0 +1,100 @@ + + +Formatting.Formatting 1 strings.concat 2.47 μs + +2.47 μs ± 186 ns + + + + + + +Formatting.Formatting 1 strings.format 3.95 μs + +3.95 μs ± 167 ns + + + + + + +Formatting.Formatting 10 strings.concat 26.4 μs + +26.4 μs ± 1.7 μs + + + + + + +Formatting.Formatting 10 strings.format 39.9 μs + +39.9 μs ± 3.1 μs + + + + + + +Formatting.Formatting 100 strings.concat 256 μs + +256 μs ± 24 μs + + + + + + +Formatting.Formatting 100 strings.format 398 μs + +398 μs ± 21 μs + + + + + + +Formatting.Formatting 1000 strings.concat 2.71 ms + +2.71 ms ± 244 μs + + + + + + +Formatting.Formatting 1000 strings.format 4.13 ms + +4.13 ms ± 231 μs + + + + + + + +Formatting.Formatting 10000 strings.concat +27.2 ms + + +27.2 ms ± 1.8 ms + + + + + + + +Formatting.Formatting 10000 strings.format +41.4 ms + + +41.4 ms ± 3.5 ms + + + + + + + + diff --git a/results_cpu_o1.svg b/results_cpu_o1.svg new file mode 100644 --- /dev/null +++ b/results_cpu_o1.svg @@ -0,0 +1,100 @@ + + +Formatting.Formatting 1 strings.concat 1.01 μs + +1.01 μs ± 76 ns + + + + + + +Formatting.Formatting 1 strings.format 949 ns + +949 ns ± 84 ns + + + + + + +Formatting.Formatting 10 strings.concat 10.5 μs + +10.5 μs ± 1.0 μs + + + + + + +Formatting.Formatting 10 strings.format 9.86 μs + +9.86 μs ± 391 ns + + + + + + +Formatting.Formatting 100 strings.concat 102 μs + +102 μs ± 5.8 μs + + + + + + +Formatting.Formatting 100 strings.format 99.4 μs + +99.4 μs ± 5.7 μs + + + + + + +Formatting.Formatting 1000 strings.concat 1.05 ms + +1.05 ms ± 104 μs + + + + + + +Formatting.Formatting 1000 strings.format 1.03 ms + +1.03 ms ± 102 μs + + + + + + + +Formatting.Formatting 10000 strings.concat +11.5 ms + + +11.5 ms ± 760 μs + + + + + + + +Formatting.Formatting 10000 strings.format +11.3 ms + + +11.3 ms ± 708 μs + + + + + + + + diff --git a/results_cpu_o2.svg b/results_cpu_o2.svg new file mode 100644 --- /dev/null +++ b/results_cpu_o2.svg @@ -0,0 +1,100 @@ + + +Formatting.Formatting 1 strings.concat 861 ns + +861 ns ± 42 ns + + + + + + +Formatting.Formatting 1 strings.format 888 ns + +888 ns ± 79 ns + + + + + + +Formatting.Formatting 10 strings.concat 9.13 μs + +9.13 μs ± 689 ns + + + + + + +Formatting.Formatting 10 strings.format 9.22 μs + +9.22 μs ± 732 ns + + + + + + +Formatting.Formatting 100 strings.concat 91.1 μs + +91.1 μs ± 7.9 μs + + + + + + +Formatting.Formatting 100 strings.format 90.0 μs + +90.0 μs ± 6.4 μs + + + + + + +Formatting.Formatting 1000 strings.concat 900 μs + +900 μs ± 42 μs + + + + + + +Formatting.Formatting 1000 strings.format 902 μs + +902 μs ± 90 μs + + + + + + + +Formatting.Formatting 10000 strings.concat +9.89 ms + + +9.89 ms ± 723 μs + + + + + + + +Formatting.Formatting 10000 strings.format +10.3 ms + + +10.3 ms ± 354 μs + + + + + + + + diff --git a/typist.cabal b/typist.cabal --- a/typist.cabal +++ b/typist.cabal @@ -1,14 +1,22 @@ cabal-version: 3.0 name: typist -version: 0.1.0.0 +version: 0.1.0.1 license: MIT license-file: LICENSE author: Danil Berestov maintainer: goosedb@yandex.ru +homepage: https://github.com/goosedb/typist + category: Text -extra-source-files: CHANGELOG.md +extra-source-files: + CHANGELOG.md + README.md + results_cpu_o0.svg + results_cpu_o1.svg + results_cpu_o2.svg + synopsis: Typelevel printf library