Lists, Texts, ByteStrings and Vectors of statically known length

Version on this page:
LTS Haskell 22.26:
Stackage Nightly 2024-06-21:
Latest on Hackage:

See all snapshots static-text appears in

BSD-3-Clause licensed by Dmitry Dzhus
Maintained by [email protected]
This version can be pinned in stack with:static-text-,2751

Module documentation for

static-text: lists, Texts, ByteStrings and Vectors of statically known length

Travis CI build status Hackage Hackage deps

static-text provides type-level safety for basic operations on string-like types (finite lists of elements), such as Data.Text, String (and all lists), Data.ByteString and Data.Vector. Use it when you need static guarantee on lengths of strings produced in your code.

An example application would be a network exchange protocol built of packets with fixed-width fields:

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TemplateHaskell #-}
import Data.ByteString.Char8 (ByteString, pack)
import Data.StaticText

mkPacket :: ByteString -> Static ByteString 32
mkPacket inp =
  -- 5-character version signature
  $(st "PKT10") `append`
  -- 25-character payload
  payload `append`
  -- 2-character payload checksum
    payload = createLeft 0x20 inp
    checksum :: Static ByteString 2
    checksum = createLeft 0x20 $
               pack $ show $ Data.StaticText.length payload `mod` 100

message :: Static ByteString 64
message = mkPacket "Hello" `append` mkPacket "world"

main :: IO ()
main = print message

Please consult the Hackage page for static-text for documentation and examples.


The emphasis of static-text is on type-safe padding/truncation and type-safe string literals. Other similar libraries may suit different use cases:


Changelog - 2018-07-30


  • Use doctest-driver-gen to run doctests

  • Dependencies bump

  • Use markdown-unlit to test code example in README - 2018-03-15


  • GHC 8.4.x support

0.2.0 - 2018-02-17


  • Package renamed to static-text as per Old names were changed as follows:

    before after
    Data.Sext Data.StaticText
    Sext n a Static a n
    Sextable a IsStaticText a
    $(sext ..) $(st ..) - 2017-10-29


  • GHC 8.2.x support

0.1.3 - 2017-03-26


  • ShortByteString support


0.1.2 - 2017-01-18


0.1.1 - 2016-19-12


  • GHC 8.0.x support - 2015-12-06


  • GHC 7.10.x support - 2014-08-10