Data.StaticText.Class

Use this module when you need to add an IsStaticText instance to a type.

Documentation

class IsStaticText a where

Class of types which can be assigned a type-level length.

Minimal complete definition

unsafeCreate, unwrap, length, append, replicate, map, take, drop

Associated Types

data Static a (i :: Nat)

Data family which wraps values of the underlying type giving them a type-level length. Static t 6 means a value of type t of length 6.

type Elem a

Basic element type. For IsStaticText [a], this is a.

Methods

unsafeCreate :: a -> Static a i

Simply wrap a value in a Static as is, assuming any length.

WARNING Use it only when you know what you're doing.

For example, an expression like

unsafeCreate "somestring" :: Static String 50

will typecheck, although the stored length information will not match actual string size. This may result in wrong behaviour of all functions defined for IsStaticText.

When writing new IsStaticText instances, make this simply apply the constructor of Static.

unwrap :: Static a i -> a

Forget type-level length, obtaining the underlying value.

length :: a -> Int

append :: a -> a -> a

replicate :: Int -> Elem a -> a

map :: (Elem a -> Elem a) -> a -> a

take :: Int -> a -> a

drop :: Int -> a -> a

Instances

IsStaticText ShortByteString

IsStaticText instance for ShortByteString uses intermediate ByteStrings (pinned) for all modification operations.

Defined in Data.StaticText.Class

Associated Types

data Static ShortByteString i :: *

type Elem ShortByteString :: *

Methods

unsafeCreate :: ShortByteString -> Static ShortByteString i

unwrap :: Static ShortByteString i -> ShortByteString

length :: ShortByteString -> Int

append :: ShortByteString -> ShortByteString -> ShortByteString

replicate :: Int -> Elem ShortByteString -> ShortByteString

map :: (Elem ShortByteString -> Elem ShortByteString) -> ShortByteString -> ShortByteString

take :: Int -> ShortByteString -> ShortByteString

drop :: Int -> ShortByteString -> ShortByteString

IsStaticText ByteString

Defined in Data.StaticText.Class

Associated Types

data Static ByteString i :: *

type Elem ByteString :: *

Methods

unsafeCreate :: ByteString -> Static ByteString i

unwrap :: Static ByteString i -> ByteString

length :: ByteString -> Int

append :: ByteString -> ByteString -> ByteString

replicate :: Int -> Elem ByteString -> ByteString

map :: (Elem ByteString -> Elem ByteString) -> ByteString -> ByteString

take :: Int -> ByteString -> ByteString

drop :: Int -> ByteString -> ByteString

IsStaticText Text

Defined in Data.StaticText.Class

Associated Types

data Static Text i :: *

type Elem Text :: *

Methods

unsafeCreate :: Text -> Static Text i

unwrap :: Static Text i -> Text

length :: Text -> Int

append :: Text -> Text -> Text

replicate :: Int -> Elem Text -> Text

map :: (Elem Text -> Elem Text) -> Text -> Text

take :: Int -> Text -> Text

drop :: Int -> Text -> Text

IsStaticText [a]

Defined in Data.StaticText.Class

Associated Types

data Static [a] i :: *

type Elem [a] :: *

Methods

unsafeCreate :: [a] -> Static [a] i

unwrap :: Static [a] i -> [a]

length :: [a] -> Int

append :: [a] -> [a] -> [a]

replicate :: Int -> Elem [a] -> [a]

map :: (Elem [a] -> Elem [a]) -> [a] -> [a]

take :: Int -> [a] -> [a]

drop :: Int -> [a] -> [a]

IsStaticText (Vector a)

Defined in Data.StaticText.Class

Associated Types

data Static (Vector a) i :: *

type Elem (Vector a) :: *

Methods

unsafeCreate :: Vector a -> Static (Vector a) i

unwrap :: Static (Vector a) i -> Vector a

length :: Vector a -> Int

append :: Vector a -> Vector a -> Vector a

replicate :: Int -> Elem (Vector a) -> Vector a

map :: (Elem (Vector a) -> Elem (Vector a)) -> Vector a -> Vector a

take :: Int -> Vector a -> Vector a

drop :: Int -> Vector a -> Vector a